Package com.hashicorp.cdktf.providers.google.compute_region_backend_service

Interface ComputeRegionBackendServiceBackend

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    ComputeRegionBackendServiceBackend.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.683Z")
@Stability(Stable)
public interface ComputeRegionBackendServiceBackend
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getGroup

        @Stability(Stable)
@NotNull
String getGroup()
        The fully-qualified URL of an Instance Group or Network Endpoint Group resource.

        In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend services cannot mix Instance Group and Network Endpoint Group backends. When the 'load_balancing_scheme' is INTERNAL, only instance groups are supported. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#group ComputeRegionBackendService#group}

      • getBalancingMode

        @Stability(Stable)
@Nullable
default String getBalancingMode()
        Specifies the balancing mode for this backend.

        See the [Backend Services Overview](https://cloud.google.com/load-balancing/docs/backend-service#balancing-mode) for an explanation of load balancing modes. From version 6.0.0 default value will be UTILIZATION to match default GCP value. Default value: "CONNECTION" Possible values: ["UTILIZATION", "RATE", "CONNECTION"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#balancing_mode ComputeRegionBackendService#balancing_mode}

      • getCapacityScaler

        @Stability(Stable)
@Nullable
default Number getCapacityScaler()
        A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

        ~>**NOTE**: This field cannot be set for INTERNAL region backend services (default loadBalancingScheme), but is required for non-INTERNAL backend service. The total capacity_scaler for all backends must be non-zero. A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#capacity_scaler ComputeRegionBackendService#capacity_scaler}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        An optional description of this resource. Provide this property when you create the resource.

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

      • getFailover

        @Stability(Stable)
@Nullable
default Object getFailover()
        This field designates whether this is a failover backend.

        More than one failover backend can be configured for a given RegionBackendService. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#failover ComputeRegionBackendService#failover}

      • getMaxConnections

        @Stability(Stable)
@Nullable
default Number getMaxConnections()
        The max number of simultaneous connections for the group.

        Can be used with either CONNECTION or UTILIZATION balancing modes. Cannot be set for INTERNAL backend services. For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_connections ComputeRegionBackendService#max_connections}

      • getMaxConnectionsPerEndpoint

        @Stability(Stable)
@Nullable
default Number getMaxConnectionsPerEndpoint()
        The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

        This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_connections_per_endpoint ComputeRegionBackendService#max_connections_per_endpoint}

      • getMaxConnectionsPerInstance

        @Stability(Stable)
@Nullable
default Number getMaxConnectionsPerInstance()
        The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

        This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_connections_per_instance ComputeRegionBackendService#max_connections_per_instance}

      • getMaxRate

        @Stability(Stable)
@Nullable
default Number getMaxRate()
        The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services.

        Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_rate ComputeRegionBackendService#max_rate}

      • getMaxRatePerEndpoint

        @Stability(Stable)
@Nullable
default Number getMaxRatePerEndpoint()
        The max requests per second (RPS) that a single backend network endpoint can handle.

        This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. Cannot be set for INTERNAL backend services. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_rate_per_endpoint ComputeRegionBackendService#max_rate_per_endpoint}

      • getMaxRatePerInstance

        @Stability(Stable)
@Nullable
default Number getMaxRatePerInstance()
        The max requests per second (RPS) that a single backend instance can handle.

        This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. Cannot be set for INTERNAL backend services. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_rate_per_instance ComputeRegionBackendService#max_rate_per_instance}

      • getMaxUtilization

        @Stability(Stable)
@Nullable
default Number getMaxUtilization()
        Used when balancingMode is UTILIZATION.

        This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. Cannot be set for INTERNAL backend services. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_region_backend_service#max_utilization ComputeRegionBackendService#max_utilization}