Package com.hashicorp.cdktf.providers.google.compute_backend_service

Class ComputeBackendService.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ComputeBackendService.Builder create​(software.constructs.Construct scope,
                                                   String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of ComputeBackendService.Builder.

      • connection

        @Stability(Experimental)
public ComputeBackendService.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public ComputeBackendService.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ComputeBackendService.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public ComputeBackendService.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public ComputeBackendService.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public ComputeBackendService.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public ComputeBackendService.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public ComputeBackendService.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ComputeBackendService.Builder name​(String name)
        Name of the resource.

        Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#name ComputeBackendService#name}

        Parameters:
        name - Name of the resource. This parameter is required.
        Returns:
        this

      • affinityCookieTtlSec

        @Stability(Stable)
public ComputeBackendService.Builder affinityCookieTtlSec​(Number affinityCookieTtlSec)
        Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.

        If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#affinity_cookie_ttl_sec ComputeBackendService#affinity_cookie_ttl_sec}

        Parameters:
        affinityCookieTtlSec - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. This parameter is required.
        Returns:
        this

      • backend

        @Stability(Stable)
public ComputeBackendService.Builder backend​(com.hashicorp.cdktf.IResolvable backend)
        backend block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#backend ComputeBackendService#backend}

        Parameters:
        backend - backend block. This parameter is required.
        Returns:
        this

      • backend

        @Stability(Stable)
public ComputeBackendService.Builder backend​(List<? extends ComputeBackendServiceBackend> backend)
        backend block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#backend ComputeBackendService#backend}

        Parameters:
        backend - backend block. This parameter is required.
        Returns:
        this

      • cdnPolicy

        @Stability(Stable)
public ComputeBackendService.Builder cdnPolicy​(ComputeBackendServiceCdnPolicy cdnPolicy)
        cdn_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#cdn_policy ComputeBackendService#cdn_policy}

        Parameters:
        cdnPolicy - cdn_policy block. This parameter is required.
        Returns:
        this

      • circuitBreakers

        @Stability(Stable)
public ComputeBackendService.Builder circuitBreakers​(ComputeBackendServiceCircuitBreakers circuitBreakers)
        circuit_breakers block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#circuit_breakers ComputeBackendService#circuit_breakers}

        Parameters:
        circuitBreakers - circuit_breakers block. This parameter is required.
        Returns:
        this

      • compressionMode

        @Stability(Stable)
public ComputeBackendService.Builder compressionMode​(String compressionMode)
        Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values: ["AUTOMATIC", "DISABLED"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#compression_mode ComputeBackendService#compression_mode}

        Parameters:
        compressionMode - Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values: ["AUTOMATIC", "DISABLED"]. This parameter is required.
        Returns:
        this

      • connectionDrainingTimeoutSec

        @Stability(Stable)
public ComputeBackendService.Builder connectionDrainingTimeoutSec​(Number connectionDrainingTimeoutSec)
        Time for which instance will be drained (not accept new connections, but still work to finish started).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#connection_draining_timeout_sec ComputeBackendService#connection_draining_timeout_sec}

        Parameters:
        connectionDrainingTimeoutSec - Time for which instance will be drained (not accept new connections, but still work to finish started). This parameter is required.
        Returns:
        this

      • consistentHash

        @Stability(Stable)
public ComputeBackendService.Builder consistentHash​(ComputeBackendServiceConsistentHash consistentHash)
        consistent_hash block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#consistent_hash ComputeBackendService#consistent_hash}

        Parameters:
        consistentHash - consistent_hash block. This parameter is required.
        Returns:
        this

      • customRequestHeaders

        @Stability(Stable)
public ComputeBackendService.Builder customRequestHeaders​(List<String> customRequestHeaders)
        Headers that the HTTP/S load balancer should add to proxied requests.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#custom_request_headers ComputeBackendService#custom_request_headers}

        Parameters:
        customRequestHeaders - Headers that the HTTP/S load balancer should add to proxied requests. This parameter is required.
        Returns:
        this

      • customResponseHeaders

        @Stability(Stable)
public ComputeBackendService.Builder customResponseHeaders​(List<String> customResponseHeaders)
        Headers that the HTTP/S load balancer should add to proxied responses.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#custom_response_headers ComputeBackendService#custom_response_headers}

        Parameters:
        customResponseHeaders - Headers that the HTTP/S load balancer should add to proxied responses. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ComputeBackendService.Builder description​(String description)
        An optional description of this resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#description ComputeBackendService#description}

        Parameters:
        description - An optional description of this resource. This parameter is required.
        Returns:
        this

      • edgeSecurityPolicy

        @Stability(Stable)
public ComputeBackendService.Builder edgeSecurityPolicy​(String edgeSecurityPolicy)
        The resource URL for the edge security policy associated with this backend service.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#edge_security_policy ComputeBackendService#edge_security_policy}

        Parameters:
        edgeSecurityPolicy - The resource URL for the edge security policy associated with this backend service. This parameter is required.
        Returns:
        this

      • enableCdn

        @Stability(Stable)
public ComputeBackendService.Builder enableCdn​(Boolean enableCdn)
        If true, enable Cloud CDN for this BackendService.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#enable_cdn ComputeBackendService#enable_cdn}

        Parameters:
        enableCdn - If true, enable Cloud CDN for this BackendService. This parameter is required.
        Returns:
        this

      • enableCdn

        @Stability(Stable)
public ComputeBackendService.Builder enableCdn​(com.hashicorp.cdktf.IResolvable enableCdn)
        If true, enable Cloud CDN for this BackendService.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#enable_cdn ComputeBackendService#enable_cdn}

        Parameters:
        enableCdn - If true, enable Cloud CDN for this BackendService. This parameter is required.
        Returns:
        this

      • healthChecks

        @Stability(Stable)
public ComputeBackendService.Builder healthChecks​(List<String> healthChecks)
        The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.

        Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#health_checks ComputeBackendService#health_checks}

        Parameters:
        healthChecks - The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. This parameter is required.
        Returns:
        this

      • iap

        @Stability(Stable)
public ComputeBackendService.Builder iap​(ComputeBackendServiceIap iap)
        iap block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#iap ComputeBackendService#iap}

        Parameters:
        iap - iap block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ComputeBackendService.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#id ComputeBackendService#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#id ComputeBackendService#id}. This parameter is required.
        Returns:
        this

      • loadBalancingScheme

        @Stability(Stable)
public ComputeBackendService.Builder loadBalancingScheme​(String loadBalancingScheme)
        Indicates whether the backend service will be used with internal or external load balancing.

        A backend service created for one type of load balancing cannot be used with the other. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "INTERNAL_SELF_MANAGED", "INTERNAL_MANAGED", "EXTERNAL_MANAGED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#load_balancing_scheme ComputeBackendService#load_balancing_scheme}

        Parameters:
        loadBalancingScheme - Indicates whether the backend service will be used with internal or external load balancing. This parameter is required.
        Returns:
        this

      • localityLbPolicies

        @Stability(Stable)
public ComputeBackendService.Builder localityLbPolicies​(com.hashicorp.cdktf.IResolvable localityLbPolicies)
        locality_lb_policies block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#locality_lb_policies ComputeBackendService#locality_lb_policies}

        Parameters:
        localityLbPolicies - locality_lb_policies block. This parameter is required.
        Returns:
        this

      • localityLbPolicies

        @Stability(Stable)
public ComputeBackendService.Builder localityLbPolicies​(List<? extends ComputeBackendServiceLocalityLbPolicies> localityLbPolicies)
        locality_lb_policies block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#locality_lb_policies ComputeBackendService#locality_lb_policies}

        Parameters:
        localityLbPolicies - locality_lb_policies block. This parameter is required.
        Returns:
        this

      • localityLbPolicy

        @Stability(Stable)
public ComputeBackendService.Builder localityLbPolicy​(String localityLbPolicy)
        The load balancing algorithm used within the scope of the locality. The possible values are:.

        * 'ROUND_ROBIN': This is a simple policy in which each healthy backend is selected in round robin order. * 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. * 'RING_HASH': The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. * 'RANDOM': The load balancer selects a random healthy host. * 'ORIGINAL_DESTINATION': Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. * 'MAGLEV': used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 * 'WEIGHTED_MAGLEV': Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This field is applicable to either: * A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED. * A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. * A regional backend service with loadBalancingScheme set to EXTERNAL (External Network Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External Network Load Balancing. The default is MAGLEV. If session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV, or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validate_for_proxyless field set to true. Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV", "WEIGHTED_MAGLEV"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#locality_lb_policy ComputeBackendService#locality_lb_policy}

        Parameters:
        localityLbPolicy - The load balancing algorithm used within the scope of the locality. The possible values are:. This parameter is required.
        Returns:
        this

      • logConfig

        @Stability(Stable)
public ComputeBackendService.Builder logConfig​(ComputeBackendServiceLogConfig logConfig)
        log_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#log_config ComputeBackendService#log_config}

        Parameters:
        logConfig - log_config block. This parameter is required.
        Returns:
        this

      • outlierDetection

        @Stability(Stable)
public ComputeBackendService.Builder outlierDetection​(ComputeBackendServiceOutlierDetection outlierDetection)
        outlier_detection block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#outlier_detection ComputeBackendService#outlier_detection}

        Parameters:
        outlierDetection - outlier_detection block. This parameter is required.
        Returns:
        this

      • portName

        @Stability(Stable)
public ComputeBackendService.Builder portName​(String portName)
        Name of backend port.

        The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#port_name ComputeBackendService#port_name}

        Parameters:
        portName - Name of backend port. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public ComputeBackendService.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#project ComputeBackendService#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#project ComputeBackendService#project}. This parameter is required.
        Returns:
        this

      • protocol

        @Stability(Stable)
public ComputeBackendService.Builder protocol​(String protocol)
        The protocol this BackendService uses to communicate with backends.

        The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: ["HTTP", "HTTPS", "HTTP2", "TCP", "SSL", "GRPC", "UNSPECIFIED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#protocol ComputeBackendService#protocol}

        Parameters:
        protocol - The protocol this BackendService uses to communicate with backends. This parameter is required.
        Returns:
        this

      • securityPolicy

        @Stability(Stable)
public ComputeBackendService.Builder securityPolicy​(String securityPolicy)
        The security policy associated with this backend service.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#security_policy ComputeBackendService#security_policy}

        Parameters:
        securityPolicy - The security policy associated with this backend service. This parameter is required.
        Returns:
        this

      • securitySettings

        @Stability(Stable)
public ComputeBackendService.Builder securitySettings​(ComputeBackendServiceSecuritySettings securitySettings)
        security_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#security_settings ComputeBackendService#security_settings}

        Parameters:
        securitySettings - security_settings block. This parameter is required.
        Returns:
        this

      • serviceLbPolicy

        @Stability(Stable)
public ComputeBackendService.Builder serviceLbPolicy​(String serviceLbPolicy)
        URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#service_lb_policy ComputeBackendService#service_lb_policy}

        Parameters:
        serviceLbPolicy - URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. This parameter is required.
        Returns:
        this

      • sessionAffinity

        @Stability(Stable)
public ComputeBackendService.Builder sessionAffinity​(String sessionAffinity)
        Type of session affinity to use.

        The default is NONE. Session affinity is not applicable if the protocol is UDP. Possible values: ["NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#session_affinity ComputeBackendService#session_affinity}

        Parameters:
        sessionAffinity - Type of session affinity to use. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeBackendService.Builder timeouts​(ComputeBackendServiceTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#timeouts ComputeBackendService#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • timeoutSec

        @Stability(Stable)
public ComputeBackendService.Builder timeoutSec​(Number timeoutSec)
        The backend service timeout has a different meaning depending on the type of load balancer.

        For more information see, [Backend service settings](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices). The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_backend_service#timeout_sec ComputeBackendService#timeout_sec}

        Parameters:
        timeoutSec - The backend service timeout has a different meaning depending on the type of load balancer. This parameter is required.
        Returns:
        this