Class: Aws::ElasticLoadBalancingV2::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb

Overview

An API client for ElasticLoadBalancingV2. To construct a client, you need to configure a :region and :credentials.

client = Aws::ElasticLoadBalancingV2::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ElasticLoadBalancingV2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ElasticLoadBalancingV2::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#add_listener_certificates(params = {}) ⇒ Types::AddListenerCertificatesOutput

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

Examples:

Request syntax with placeholder values


resp = client.add_listener_certificates({
  listener_arn: "ListenerArn", # required
  certificates: [ # required
    {
      certificate_arn: "CertificateArn",
      is_default: false,
    },
  ],
})

Response structure


resp.certificates #=> Array
resp.certificates[0].certificate_arn #=> String
resp.certificates[0].is_default #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :certificates (required, Array<Types::Certificate>) —

    The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

Returns:

See Also:



532
533
534
535
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 532

def add_listener_certificates(params = {}, options = {})
  req = build_request(:add_listener_certificates, params)
  req.send_request(options)
end

#add_tags(params = {}) ⇒ Struct

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

Examples:

Example: To add tags to a load balancer


# This example adds the specified tags to the specified load balancer.

resp = client.add_tags({
  resource_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  ], 
  tags: [
    {
      key: "project", 
      value: "lima", 
    }, 
    {
      key: "department", 
      value: "digital-media", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.add_tags({
  resource_arns: ["ResourceArn"], # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arns (required, Array<String>) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Array<Types::Tag>) —

    The tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



590
591
592
593
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 590

def add_tags(params = {}, options = {})
  req = build_request(:add_tags, params)
  req.send_request(options)
end

#add_trust_store_revocations(params = {}) ⇒ Types::AddTrustStoreRevocationsOutput

Adds the specified revocation file to the specified trust store.

Examples:

Request syntax with placeholder values


resp = client.add_trust_store_revocations({
  trust_store_arn: "TrustStoreArn", # required
  revocation_contents: [
    {
      s3_bucket: "S3Bucket",
      s3_key: "S3Key",
      s3_object_version: "S3ObjectVersion",
      revocation_type: "CRL", # accepts CRL
    },
  ],
})

Response structure


resp.trust_store_revocations #=> Array
resp.trust_store_revocations[0].trust_store_arn #=> String
resp.trust_store_revocations[0].revocation_id #=> Integer
resp.trust_store_revocations[0].revocation_type #=> String, one of "CRL"
resp.trust_store_revocations[0].number_of_revoked_entries #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :revocation_contents (Array<Types::RevocationContent>) —

    The revocation file to add.

Returns:

See Also:



633
634
635
636
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 633

def add_trust_store_revocations(params = {}, options = {})
  req = build_request(:add_trust_store_revocations, params)
  req.send_request(options)
end

#create_listener(params = {}) ⇒ Types::CreateListenerOutput

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.

Examples:

Example: To create an HTTP listener


# This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target
# group.

resp = client.create_listener({
  default_actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      type: "forward", 
    }, 
  ], 
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  port: 80, 
  protocol: "HTTP", 
})

resp.to_h outputs the following:
{
  listeners: [
    {
      default_actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      port: 80, 
      protocol: "HTTP", 
    }, 
  ], 
}

Example: To create an HTTPS listener


# This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target
# group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using
# AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate
# signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).

resp = client.create_listener({
  certificates: [
    {
      certificate_arn: "arn:aws:iam::123456789012:server-certificate/my-server-cert", 
    }, 
  ], 
  default_actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      type: "forward", 
    }, 
  ], 
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  port: 443, 
  protocol: "HTTPS", 
  ssl_policy: "ELBSecurityPolicy-2015-05", 
})

resp.to_h outputs the following:
{
  listeners: [
    {
      certificates: [
        {
          certificate_arn: "arn:aws:iam::123456789012:server-certificate/my-server-cert", 
        }, 
      ], 
      default_actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      port: 443, 
      protocol: "HTTPS", 
      ssl_policy: "ELBSecurityPolicy-2015-05", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.create_listener({
  load_balancer_arn: "LoadBalancerArn", # required
  protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE, QUIC, TCP_QUIC
  port: 1,
  ssl_policy: "SslPolicyName",
  certificates: [
    {
      certificate_arn: "CertificateArn",
      is_default: false,
    },
  ],
  default_actions: [ # required
    {
      type: "forward", # required, accepts forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response, jwt-validation
      target_group_arn: "TargetGroupArn",
      authenticate_oidc_config: {
        issuer: "AuthenticateOidcActionIssuer", # required
        authorization_endpoint: "AuthenticateOidcActionAuthorizationEndpoint", # required
        token_endpoint: "AuthenticateOidcActionTokenEndpoint", # required
        user_info_endpoint: "AuthenticateOidcActionUserInfoEndpoint", # required
        client_id: "AuthenticateOidcActionClientId", # required
        client_secret: "AuthenticateOidcActionClientSecret",
        session_cookie_name: "AuthenticateOidcActionSessionCookieName",
        scope: "AuthenticateOidcActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateOidcActionAuthenticationRequestParamName" => "AuthenticateOidcActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
        use_existing_client_secret: false,
      },
      authenticate_cognito_config: {
        user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
        user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
        user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
        session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
        scope: "AuthenticateCognitoActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
      },
      order: 1,
      redirect_config: {
        protocol: "RedirectActionProtocol",
        port: "RedirectActionPort",
        host: "RedirectActionHost",
        path: "RedirectActionPath",
        query: "RedirectActionQuery",
        status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
      },
      fixed_response_config: {
        message_body: "FixedResponseActionMessage",
        status_code: "FixedResponseActionStatusCode", # required
        content_type: "FixedResponseActionContentType",
      },
      forward_config: {
        target_groups: [
          {
            target_group_arn: "TargetGroupArn",
            weight: 1,
          },
        ],
        target_group_stickiness_config: {
          enabled: false,
          duration_seconds: 1,
        },
      },
      jwt_validation_config: {
        jwks_endpoint: "JwtValidationActionJwksEndpoint", # required
        issuer: "JwtValidationActionIssuer", # required
        additional_claims: [
          {
            format: "single-string", # required, accepts single-string, string-array, space-separated-values
            name: "JwtValidationActionAdditionalClaimName", # required
            values: ["JwtValidationActionAdditionalClaimValue"], # required
          },
        ],
      },
    },
  ],
  alpn_policy: ["AlpnPolicyValue"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  mutual_authentication: {
    mode: "Mode",
    trust_store_arn: "TrustStoreArn",
    ignore_client_certificate_expiry: false,
    trust_store_association_status: "active", # accepts active, removed
    advertise_trust_store_ca_names: "on", # accepts on, off
  },
})

Response structure


resp.listeners #=> Array
resp.listeners[0].listener_arn #=> String
resp.listeners[0].load_balancer_arn #=> String
resp.listeners[0].port #=> Integer
resp.listeners[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.listeners[0].certificates #=> Array
resp.listeners[0].certificates[0].certificate_arn #=> String
resp.listeners[0].certificates[0].is_default #=> Boolean
resp.listeners[0].ssl_policy #=> String
resp.listeners[0].default_actions #=> Array
resp.listeners[0].default_actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.listeners[0].default_actions[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.issuer #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config. #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_id #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_secret #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].order #=> Integer
resp.listeners[0].default_actions[0].redirect_config.protocol #=> String
resp.listeners[0].default_actions[0].redirect_config.port #=> String
resp.listeners[0].default_actions[0].redirect_config.host #=> String
resp.listeners[0].default_actions[0].redirect_config.path #=> String
resp.listeners[0].default_actions[0].redirect_config.query #=> String
resp.listeners[0].default_actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.listeners[0].default_actions[0].fixed_response_config.message_body #=> String
resp.listeners[0].default_actions[0].fixed_response_config.status_code #=> String
resp.listeners[0].default_actions[0].fixed_response_config.content_type #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups #=> Array
resp.listeners[0].default_actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups[0].weight #=> Integer
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.listeners[0].default_actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.issuer #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.listeners[0].alpn_policy #=> Array
resp.listeners[0].alpn_policy[0] #=> String
resp.listeners[0].mutual_authentication.mode #=> String
resp.listeners[0].mutual_authentication.trust_store_arn #=> String
resp.listeners[0].mutual_authentication.ignore_client_certificate_expiry #=> Boolean
resp.listeners[0].mutual_authentication.trust_store_association_status #=> String, one of "active", "removed"
resp.listeners[0].mutual_authentication.advertise_trust_store_ca_names #=> String, one of "on", "off"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :protocol (String) —

    The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC. You can’t specify the UDP, TCP_UDP, QUIC, or TCP_QUIC protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.

  • :port (Integer) —

    The port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer.

  • :ssl_policy (String) —

    [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

    For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.

  • :certificates (Array<Types::Certificate>) —

    [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

  • :default_actions (required, Array<Types::Action>) —

    The actions for the default rule.

  • :alpn_policy (Array<String>) —

    [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

    • HTTP1Only

    • HTTP2Only

    • HTTP2Optional

    • HTTP2Preferred

    • None

    For more information, see ALPN policies in the Network Load Balancers Guide.

  • :tags (Array<Types::Tag>) —

    The tags to assign to the listener.

  • :mutual_authentication (Types::MutualAuthenticationAttributes) —

    [HTTPS listeners] The mutual authentication configuration information.

Returns:

See Also:



983
984
985
986
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 983

def create_listener(params = {}, options = {})
  req = build_request(:create_listener, params)
  req.send_request(options)
end

#create_load_balancer(params = {}) ⇒ Types::CreateLoadBalancerOutput

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

Examples:

Example: To create an Internet-facing load balancer


# This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.

resp = client.create_load_balancer({
  name: "my-load-balancer", 
  subnets: [
    "subnet-b7d581c0", 
    "subnet-8360a9e7", 
  ], 
})

resp.to_h outputs the following:
{
  load_balancers: [
    {
      availability_zones: [
        {
          subnet_id: "subnet-8360a9e7", 
          zone_name: "us-west-2a", 
        }, 
        {
          subnet_id: "subnet-b7d581c0", 
          zone_name: "us-west-2b", 
        }, 
      ], 
      canonical_hosted_zone_id: "Z2P70J7EXAMPLE", 
      created_time: Time.parse("2016-03-25T21:26:12.920Z"), 
      dns_name: "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      load_balancer_name: "my-load-balancer", 
      scheme: "internet-facing", 
      security_groups: [
        "sg-5943793c", 
      ], 
      state: {
        code: "provisioning", 
      }, 
      type: "application", 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Example: To create an internal load balancer


# This example creates an internal load balancer and enables the Availability Zones for the specified subnets.

resp = client.create_load_balancer({
  name: "my-internal-load-balancer", 
  scheme: "internal", 
  security_groups: [
  ], 
  subnets: [
    "subnet-b7d581c0", 
    "subnet-8360a9e7", 
  ], 
})

resp.to_h outputs the following:
{
  load_balancers: [
    {
      availability_zones: [
        {
          subnet_id: "subnet-8360a9e7", 
          zone_name: "us-west-2a", 
        }, 
        {
          subnet_id: "subnet-b7d581c0", 
          zone_name: "us-west-2b", 
        }, 
      ], 
      canonical_hosted_zone_id: "Z2P70J7EXAMPLE", 
      created_time: Time.parse("2016-03-25T21:29:48.850Z"), 
      dns_name: "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", 
      load_balancer_name: "my-internal-load-balancer", 
      scheme: "internal", 
      security_groups: [
        "sg-5943793c", 
      ], 
      state: {
        code: "provisioning", 
      }, 
      type: "application", 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.create_load_balancer({
  name: "LoadBalancerName", # required
  subnets: ["SubnetId"],
  subnet_mappings: [
    {
      subnet_id: "SubnetId",
      allocation_id: "AllocationId",
      private_i_pv_4_address: "PrivateIPv4Address",
      i_pv_6_address: "IPv6Address",
      source_nat_ipv_6_prefix: "SourceNatIpv6Prefix",
    },
  ],
  security_groups: ["SecurityGroupId"],
  scheme: "internet-facing", # accepts internet-facing, internal
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  type: "application", # accepts application, network, gateway
  ip_address_type: "ipv4", # accepts ipv4, dualstack, dualstack-without-public-ipv4
  customer_owned_ipv_4_pool: "CustomerOwnedIpv4Pool",
  enable_prefix_for_ipv_6_source_nat: "on", # accepts on, off
  ipam_pools: {
    ipv_4_ipam_pool_id: "IpamPoolId",
  },
})

Response structure


resp.load_balancers #=> Array
resp.load_balancers[0].load_balancer_arn #=> String
resp.load_balancers[0].dns_name #=> String
resp.load_balancers[0].canonical_hosted_zone_id #=> String
resp.load_balancers[0].created_time #=> Time
resp.load_balancers[0].load_balancer_name #=> String
resp.load_balancers[0].scheme #=> String, one of "internet-facing", "internal"
resp.load_balancers[0].vpc_id #=> String
resp.load_balancers[0].state.code #=> String, one of "active", "provisioning", "active_impaired", "failed"
resp.load_balancers[0].state.reason #=> String
resp.load_balancers[0].type #=> String, one of "application", "network", "gateway"
resp.load_balancers[0].availability_zones #=> Array
resp.load_balancers[0].availability_zones[0].zone_name #=> String
resp.load_balancers[0].availability_zones[0].subnet_id #=> String
resp.load_balancers[0].availability_zones[0].outpost_id #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses #=> Array
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].ip_address #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].allocation_id #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].private_i_pv_4_address #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].i_pv_6_address #=> String
resp.load_balancers[0].availability_zones[0].source_nat_ipv_6_prefixes #=> Array
resp.load_balancers[0].availability_zones[0].source_nat_ipv_6_prefixes[0] #=> String
resp.load_balancers[0].security_groups #=> Array
resp.load_balancers[0].security_groups[0] #=> String
resp.load_balancers[0].ip_address_type #=> String, one of "ipv4", "dualstack", "dualstack-without-public-ipv4"
resp.load_balancers[0].customer_owned_ipv_4_pool #=> String
resp.load_balancers[0].enforce_security_group_inbound_rules_on_private_link_traffic #=> String
resp.load_balancers[0].enable_prefix_for_ipv_6_source_nat #=> String, one of "on", "off"
resp.load_balancers[0].ipam_pools.ipv_4_ipam_pool_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the load balancer.

    This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

  • :subnets (Array<String>) —

    The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.

    [Application Load Balancers] You must specify subnets from at least two Availability Zones.

    [Application Load Balancers on Outposts] You must specify one Outpost subnet.

    [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

    [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

  • :subnet_mappings (Array<Types::SubnetMapping>) —

    The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.

    [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.

    [Application Load Balancers on Outposts] You must specify one Outpost subnet.

    [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

    [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

    [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.

  • :security_groups (Array<String>) —

    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.

  • :scheme (String) —

    The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

    The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

    The default is an Internet-facing load balancer.

    You can't specify a scheme for a Gateway Load Balancer.

  • :tags (Array<Types::Tag>) —

    The tags to assign to the load balancer.

  • :type (String) —

    The type of load balancer. The default is application.

  • :ip_address_type (String) —

    The IP address type. Internal load balancers must use ipv4.

    [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

    [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

  • :customer_owned_ipv_4_pool (String) —

    [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

  • :enable_prefix_for_ipv_6_source_nat (String) —

    [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.

  • :ipam_pools (Types::IpamPools) —

    [Application Load Balancers] The IPAM pools to use with the load balancer.

Returns:

See Also:



1277
1278
1279
1280
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1277

def create_load_balancer(params = {}, options = {})
  req = build_request(:create_load_balancer, params)
  req.send_request(options)
end

#create_rule(params = {}) ⇒ Types::CreateRuleOutput

Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer or a dual-stack Network Load Balancer.

Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide or Listener rules in the Network Load Balancers Guide.

Examples:

Example: To create a rule


# This example creates a rule that forwards requests to the specified target group if the URL contains the specified
# pattern (for example, /img/*).

resp = client.create_rule({
  actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      type: "forward", 
    }, 
  ], 
  conditions: [
    {
      field: "path-pattern", 
      values: [
        "/img/*", 
      ], 
    }, 
  ], 
  listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
  priority: 10, 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "path-pattern", 
          values: [
            "/img/*", 
          ], 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", 
    }, 
  ], 
}

Example: To create a listener rule that routes IPv4 traffic on a Network Load Balancer


# This example creates a rule on a dual-stack Network Load Balancer that routes IPv4 source traffic to an IPv4 target
# group.

resp = client.create_rule({
  actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", 
      type: "forward", 
    }, 
  ], 
  conditions: [
    {
      field: "source-ip", 
      source_ip_config: {
        ip_address_type: "ipv4", 
      }, 
    }, 
  ], 
  listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/net/my-nlb/1234567890abcdef/1234567890abcdef", 
  priority: 10, 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "source-ip", 
          source_ip_config: {
            ip_address_type: "ipv4", 
          }, 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.create_rule({
  listener_arn: "ListenerArn", # required
  conditions: [ # required
    {
      field: "ConditionFieldName",
      values: ["StringValue"],
      host_header_config: {
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      path_pattern_config: {
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      http_header_config: {
        http_header_name: "HttpHeaderConditionName",
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      query_string_config: {
        values: [
          {
            key: "StringValue",
            value: "StringValue",
          },
        ],
      },
      http_request_method_config: {
        values: ["StringValue"],
      },
      source_ip_config: {
        values: ["StringValue"],
        ip_address_type: "ipv4", # accepts ipv4, ipv6
      },
      regex_values: ["StringValue"],
    },
  ],
  priority: 1, # required
  actions: [ # required
    {
      type: "forward", # required, accepts forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response, jwt-validation
      target_group_arn: "TargetGroupArn",
      authenticate_oidc_config: {
        issuer: "AuthenticateOidcActionIssuer", # required
        authorization_endpoint: "AuthenticateOidcActionAuthorizationEndpoint", # required
        token_endpoint: "AuthenticateOidcActionTokenEndpoint", # required
        user_info_endpoint: "AuthenticateOidcActionUserInfoEndpoint", # required
        client_id: "AuthenticateOidcActionClientId", # required
        client_secret: "AuthenticateOidcActionClientSecret",
        session_cookie_name: "AuthenticateOidcActionSessionCookieName",
        scope: "AuthenticateOidcActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateOidcActionAuthenticationRequestParamName" => "AuthenticateOidcActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
        use_existing_client_secret: false,
      },
      authenticate_cognito_config: {
        user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
        user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
        user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
        session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
        scope: "AuthenticateCognitoActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
      },
      order: 1,
      redirect_config: {
        protocol: "RedirectActionProtocol",
        port: "RedirectActionPort",
        host: "RedirectActionHost",
        path: "RedirectActionPath",
        query: "RedirectActionQuery",
        status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
      },
      fixed_response_config: {
        message_body: "FixedResponseActionMessage",
        status_code: "FixedResponseActionStatusCode", # required
        content_type: "FixedResponseActionContentType",
      },
      forward_config: {
        target_groups: [
          {
            target_group_arn: "TargetGroupArn",
            weight: 1,
          },
        ],
        target_group_stickiness_config: {
          enabled: false,
          duration_seconds: 1,
        },
      },
      jwt_validation_config: {
        jwks_endpoint: "JwtValidationActionJwksEndpoint", # required
        issuer: "JwtValidationActionIssuer", # required
        additional_claims: [
          {
            format: "single-string", # required, accepts single-string, string-array, space-separated-values
            name: "JwtValidationActionAdditionalClaimName", # required
            values: ["JwtValidationActionAdditionalClaimValue"], # required
          },
        ],
      },
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  transforms: [
    {
      type: "host-header-rewrite", # required, accepts host-header-rewrite, url-rewrite
      host_header_rewrite_config: {
        rewrites: [
          {
            regex: "StringValue", # required
            replace: "StringValue", # required
          },
        ],
      },
      url_rewrite_config: {
        rewrites: [
          {
            regex: "StringValue", # required
            replace: "StringValue", # required
          },
        ],
      },
    },
  ],
})

Response structure


resp.rules #=> Array
resp.rules[0].rule_arn #=> String
resp.rules[0].priority #=> String
resp.rules[0].conditions #=> Array
resp.rules[0].conditions[0].field #=> String
resp.rules[0].conditions[0].values #=> Array
resp.rules[0].conditions[0].values[0] #=> String
resp.rules[0].conditions[0].host_header_config.values #=> Array
resp.rules[0].conditions[0].host_header_config.values[0] #=> String
resp.rules[0].conditions[0].host_header_config.regex_values #=> Array
resp.rules[0].conditions[0].host_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.values #=> Array
resp.rules[0].conditions[0].path_pattern_config.values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.regex_values #=> Array
resp.rules[0].conditions[0].path_pattern_config.regex_values[0] #=> String
resp.rules[0].conditions[0].http_header_config.http_header_name #=> String
resp.rules[0].conditions[0].http_header_config.values #=> Array
resp.rules[0].conditions[0].http_header_config.values[0] #=> String
resp.rules[0].conditions[0].http_header_config.regex_values #=> Array
resp.rules[0].conditions[0].http_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].query_string_config.values #=> Array
resp.rules[0].conditions[0].query_string_config.values[0].key #=> String
resp.rules[0].conditions[0].query_string_config.values[0].value #=> String
resp.rules[0].conditions[0].http_request_method_config.values #=> Array
resp.rules[0].conditions[0].http_request_method_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.values #=> Array
resp.rules[0].conditions[0].source_ip_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.ip_address_type #=> String, one of "ipv4", "ipv6"
resp.rules[0].conditions[0].regex_values #=> Array
resp.rules[0].conditions[0].regex_values[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.rules[0].actions[0].target_group_arn #=> String
resp.rules[0].actions[0].authenticate_oidc_config.issuer #=> String
resp.rules[0].actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config. #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_id #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_secret #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_oidc_config.scope #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_cognito_config.scope #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].order #=> Integer
resp.rules[0].actions[0].redirect_config.protocol #=> String
resp.rules[0].actions[0].redirect_config.port #=> String
resp.rules[0].actions[0].redirect_config.host #=> String
resp.rules[0].actions[0].redirect_config.path #=> String
resp.rules[0].actions[0].redirect_config.query #=> String
resp.rules[0].actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.rules[0].actions[0].fixed_response_config.message_body #=> String
resp.rules[0].actions[0].fixed_response_config.status_code #=> String
resp.rules[0].actions[0].fixed_response_config.content_type #=> String
resp.rules[0].actions[0].forward_config.target_groups #=> Array
resp.rules[0].actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.rules[0].actions[0].forward_config.target_groups[0].weight #=> Integer
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.rules[0].actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.rules[0].actions[0].jwt_validation_config.issuer #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.rules[0].is_default #=> Boolean
resp.rules[0].transforms #=> Array
resp.rules[0].transforms[0].type #=> String, one of "host-header-rewrite", "url-rewrite"
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].replace #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].replace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :conditions (required, Array<Types::RuleCondition>) —

    The conditions.

  • :priority (required, Integer) —

    The rule priority. A listener can't have multiple rules with the same priority.

  • :actions (required, Array<Types::Action>) —

    The actions.

  • :tags (Array<Types::Tag>) —

    The tags to assign to the rule.

  • :transforms (Array<Types::RuleTransform>) —

    The transforms to apply to requests that match this rule. You can add one host header rewrite transform and one URL rewrite transform.

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1655

def create_rule(params = {}, options = {})
  req = build_request(:create_rule, params)
  req.send_request(options)
end

#create_target_group(params = {}) ⇒ Types::CreateTargetGroupOutput

Creates a target group.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

Examples:

Example: To create a target group


# This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target
# group uses the default health check configuration.

resp = client.create_target_group({
  name: "my-targets", 
  port: 80, 
  protocol: "HTTP", 
  vpc_id: "vpc-3ac0fb5f", 
})

resp.to_h outputs the following:
{
  target_groups: [
    {
      health_check_interval_seconds: 30, 
      health_check_path: "/", 
      health_check_port: "traffic-port", 
      health_check_protocol: "HTTP", 
      health_check_timeout_seconds: 5, 
      healthy_threshold_count: 5, 
      matcher: {
        http_code: "200", 
      }, 
      port: 80, 
      protocol: "HTTP", 
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      target_group_name: "my-targets", 
      unhealthy_threshold_count: 2, 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.create_target_group({
  name: "TargetGroupName", # required
  protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE, QUIC, TCP_QUIC
  protocol_version: "ProtocolVersion",
  port: 1,
  vpc_id: "VpcId",
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE, QUIC, TCP_QUIC
  health_check_port: "HealthCheckPort",
  health_check_enabled: false,
  health_check_path: "Path",
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode",
    grpc_code: "GrpcCode",
  },
  target_type: "instance", # accepts instance, ip, lambda, alb
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  ip_address_type: "ipv4", # accepts ipv4, ipv6
  target_control_port: 1,
})

Response structure


resp.target_groups #=> Array
resp.target_groups[0].target_group_arn #=> String
resp.target_groups[0].target_group_name #=> String
resp.target_groups[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].port #=> Integer
resp.target_groups[0].vpc_id #=> String
resp.target_groups[0].health_check_protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].health_check_port #=> String
resp.target_groups[0].health_check_enabled #=> Boolean
resp.target_groups[0].health_check_interval_seconds #=> Integer
resp.target_groups[0].health_check_timeout_seconds #=> Integer
resp.target_groups[0].healthy_threshold_count #=> Integer
resp.target_groups[0].unhealthy_threshold_count #=> Integer
resp.target_groups[0].health_check_path #=> String
resp.target_groups[0].matcher.http_code #=> String
resp.target_groups[0].matcher.grpc_code #=> String
resp.target_groups[0].load_balancer_arns #=> Array
resp.target_groups[0].load_balancer_arns[0] #=> String
resp.target_groups[0].target_type #=> String, one of "instance", "ip", "lambda", "alb"
resp.target_groups[0].protocol_version #=> String
resp.target_groups[0].ip_address_type #=> String, one of "ipv4", "ipv6"
resp.target_groups[0].target_control_port #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the target group.

    This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

  • :protocol (String) —

    The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.

  • :protocol_version (String) —

    [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

  • :port (Integer) —

    The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

  • :vpc_id (String) —

    The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

  • :health_check_protocol (String) —

    The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

  • :health_check_port (String) —

    The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

  • :health_check_enabled (Boolean) —

    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and can't be disabled.

  • :health_check_path (String) —

    [HTTP/HTTPS health checks] The destination for health checks on the targets.

    [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

    [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

  • :health_check_interval_seconds (Integer) —

    The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.

  • :health_check_timeout_seconds (Integer) —

    The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.

  • :healthy_threshold_count (Integer) —

    The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda, the default is 5.

  • :unhealthy_threshold_count (Integer) —

    The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda, the default is 5.

  • :matcher (Types::Matcher) —

    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

  • :target_type (String) —

    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.

    • instance - Register targets by instance ID. This is the default value.

    • ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.

    • lambda - Register a single Lambda function as a target.

    • alb - Register a single Application Load Balancer as a target.

  • :tags (Array<Types::Tag>) —

    The tags to assign to the target group.

  • :ip_address_type (String) —

    The IP address type. The default value is ipv4.

  • :target_control_port (Integer) —

    The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

Returns:

See Also:



1911
1912
1913
1914
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1911

def create_target_group(params = {}, options = {})
  req = build_request(:create_target_group, params)
  req.send_request(options)
end

#create_trust_store(params = {}) ⇒ Types::CreateTrustStoreOutput

Creates a trust store.

For more information, see Mutual TLS for Application Load Balancers.

Examples:

Request syntax with placeholder values


resp = client.create_trust_store({
  name: "TrustStoreName", # required
  ca_certificates_bundle_s3_bucket: "S3Bucket", # required
  ca_certificates_bundle_s3_key: "S3Key", # required
  ca_certificates_bundle_s3_object_version: "S3ObjectVersion",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.trust_stores #=> Array
resp.trust_stores[0].name #=> String
resp.trust_stores[0].trust_store_arn #=> String
resp.trust_stores[0].status #=> String, one of "ACTIVE", "CREATING"
resp.trust_stores[0].number_of_ca_certificates #=> Integer
resp.trust_stores[0].total_revoked_entries #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the trust store.

    This name must be unique per region and can't be changed after creation.

  • :ca_certificates_bundle_s3_bucket (required, String) —

    The Amazon S3 bucket for the ca certificates bundle.

  • :ca_certificates_bundle_s3_key (required, String) —

    The Amazon S3 path for the ca certificates bundle.

  • :ca_certificates_bundle_s3_object_version (String) —

    The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

  • :tags (Array<Types::Tag>) —

    The tags to assign to the trust store.

Returns:

See Also:



1976
1977
1978
1979
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1976

def create_trust_store(params = {}, options = {})
  req = build_request(:create_trust_store, params)
  req.send_request(options)
end

#delete_listener(params = {}) ⇒ Struct

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer to which it is attached.

Examples:

Example: To delete a listener


# This example deletes the specified listener.

resp = client.delete_listener({
  listener_arn: "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
})

Request syntax with placeholder values


resp = client.delete_listener({
  listener_arn: "ListenerArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2010
2011
2012
2013
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2010

def delete_listener(params = {}, options = {})
  req = build_request(:delete_listener, params)
  req.send_request(options)
end

#delete_load_balancer(params = {}) ⇒ Struct

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.

You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

Examples:

Example: To delete a load balancer


# This example deletes the specified load balancer.

resp = client.delete_load_balancer({
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
})

Request syntax with placeholder values


resp = client.delete_load_balancer({
  load_balancer_arn: "LoadBalancerArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2052
2053
2054
2055
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2052

def delete_load_balancer(params = {}, options = {})
  req = build_request(:delete_load_balancer, params)
  req.send_request(options)
end

#delete_rule(params = {}) ⇒ Struct

Deletes the specified rule.

You can't delete the default rule.

Examples:

Example: To delete a rule


# This example deletes the specified rule.

resp = client.delete_rule({
  rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", 
})

Request syntax with placeholder values


resp = client.delete_rule({
  rule_arn: "RuleArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_arn (required, String) —

    The Amazon Resource Name (ARN) of the rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2085
2086
2087
2088
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2085

def delete_rule(params = {}, options = {})
  req = build_request(:delete_rule, params)
  req.send_request(options)
end

#delete_shared_trust_store_association(params = {}) ⇒ Struct

Deletes a shared trust store association.

Examples:

Example: Delete a shared trust store association


# This example deletes the association between the specified trust store and the specified load balancer.

resp = client.delete_shared_trust_store_association({
  resource_arn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-load-balancer/80233fa81d678c2c", 
  trust_store_arn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:truststore/my-trust-store/73e2d6bc24d8a063", 
})

Request syntax with placeholder values


resp = client.delete_shared_trust_store_association({
  trust_store_arn: "TrustStoreArn", # required
  resource_arn: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2121
2122
2123
2124
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2121

def delete_shared_trust_store_association(params = {}, options = {})
  req = build_request(:delete_shared_trust_store_association, params)
  req.send_request(options)
end

#delete_target_group(params = {}) ⇒ Struct

Deletes the specified target group.

You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.

Examples:

Example: To delete a target group


# This example deletes the specified target group.

resp = client.delete_target_group({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
})

Request syntax with placeholder values


resp = client.delete_target_group({
  target_group_arn: "TargetGroupArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2158
2159
2160
2161
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2158

def delete_target_group(params = {}, options = {})
  req = build_request(:delete_target_group, params)
  req.send_request(options)
end

#delete_trust_store(params = {}) ⇒ Struct

Deletes a trust store.

Examples:

Request syntax with placeholder values


resp = client.delete_trust_store({
  trust_store_arn: "TrustStoreArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2180
2181
2182
2183
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2180

def delete_trust_store(params = {}, options = {})
  req = build_request(:delete_trust_store, params)
  req.send_request(options)
end

#deregister_targets(params = {}) ⇒ Struct

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.

For more information, see the following:

Note: If the specified target does not exist, the action returns successfully.

Examples:

Example: To deregister a target from a target group


# This example deregisters the specified instance from the specified target group.

resp = client.deregister_targets({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  targets: [
    {
      id: "i-0f76fade", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.deregister_targets({
  target_group_arn: "TargetGroupArn", # required
  targets: [ # required
    {
      id: "TargetId", # required
      port: 1,
      availability_zone: "ZoneName",
      quic_server_id: "QuicServerId",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

  • :targets (required, Array<Types::TargetDescription>) —

    The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2257
2258
2259
2260
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2257

def deregister_targets(params = {}, options = {})
  req = build_request(:deregister_targets, params)
  req.send_request(options)
end

#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.

For more information, see the following:

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.limits #=> Array
resp.limits[0].name #=> String
resp.limits[0].max #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



2311
2312
2313
2314
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2311

def (params = {}, options = {})
  req = build_request(:describe_account_limits, params)
  req.send_request(options)
end

#describe_capacity_reservation(params = {}) ⇒ Types::DescribeCapacityReservationOutput

Describes the capacity reservation status for the specified load balancer.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_reservation({
  load_balancer_arn: "LoadBalancerArn", # required
})

Response structure


resp.last_modified_time #=> Time
resp.decrease_requests_remaining #=> Integer
resp.minimum_load_balancer_capacity.capacity_units #=> Integer
resp.capacity_reservation_state #=> Array
resp.capacity_reservation_state[0].state.code #=> String, one of "provisioned", "pending", "rebalancing", "failed"
resp.capacity_reservation_state[0].state.reason #=> String
resp.capacity_reservation_state[0].availability_zone #=> String
resp.capacity_reservation_state[0].effective_capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

Returns:

See Also:



2350
2351
2352
2353
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2350

def describe_capacity_reservation(params = {}, options = {})
  req = build_request(:describe_capacity_reservation, params)
  req.send_request(options)
end

#describe_listener_attributes(params = {}) ⇒ Types::DescribeListenerAttributesOutput

Describes the attributes for the specified listener.

Examples:

Example: Describe listener attributes


# This example describes the attributes of the specified listener.

resp = client.describe_listener_attributes({
  listener_arn: "aws:elasticloadbalancing:us-east-1:123456789012:listener/net/my-listener/73e2d6bc24d8a067/d5dc06411fa5bcea", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.describe_listener_attributes({
  listener_arn: "ListenerArn", # required
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

Returns:

See Also:



2393
2394
2395
2396
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2393

def describe_listener_attributes(params = {}, options = {})
  req = build_request(:describe_listener_attributes, params)
  req.send_request(options)
end

#describe_listener_certificates(params = {}) ⇒ Types::DescribeListenerCertificatesOutput

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_listener_certificates({
  listener_arn: "ListenerArn", # required
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.certificates #=> Array
resp.certificates[0].certificate_arn #=> String
resp.certificates[0].is_default #=> Boolean
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Names (ARN) of the listener.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



2450
2451
2452
2453
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2450

def describe_listener_certificates(params = {}, options = {})
  req = build_request(:describe_listener_certificates, params)
  req.send_request(options)
end

#describe_listeners(params = {}) ⇒ Types::DescribeListenersOutput

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a listener


# This example describes the specified listener.

resp = client.describe_listeners({
  listener_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
  ], 
})

resp.to_h outputs the following:
{
  listeners: [
    {
      default_actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      port: 80, 
      protocol: "HTTP", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_listeners({
  load_balancer_arn: "LoadBalancerArn",
  listener_arns: ["ListenerArn"],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.listeners #=> Array
resp.listeners[0].listener_arn #=> String
resp.listeners[0].load_balancer_arn #=> String
resp.listeners[0].port #=> Integer
resp.listeners[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.listeners[0].certificates #=> Array
resp.listeners[0].certificates[0].certificate_arn #=> String
resp.listeners[0].certificates[0].is_default #=> Boolean
resp.listeners[0].ssl_policy #=> String
resp.listeners[0].default_actions #=> Array
resp.listeners[0].default_actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.listeners[0].default_actions[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.issuer #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config. #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_id #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_secret #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].order #=> Integer
resp.listeners[0].default_actions[0].redirect_config.protocol #=> String
resp.listeners[0].default_actions[0].redirect_config.port #=> String
resp.listeners[0].default_actions[0].redirect_config.host #=> String
resp.listeners[0].default_actions[0].redirect_config.path #=> String
resp.listeners[0].default_actions[0].redirect_config.query #=> String
resp.listeners[0].default_actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.listeners[0].default_actions[0].fixed_response_config.message_body #=> String
resp.listeners[0].default_actions[0].fixed_response_config.status_code #=> String
resp.listeners[0].default_actions[0].fixed_response_config.content_type #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups #=> Array
resp.listeners[0].default_actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups[0].weight #=> Integer
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.listeners[0].default_actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.issuer #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.listeners[0].alpn_policy #=> Array
resp.listeners[0].alpn_policy[0] #=> String
resp.listeners[0].mutual_authentication.mode #=> String
resp.listeners[0].mutual_authentication.trust_store_arn #=> String
resp.listeners[0].mutual_authentication.ignore_client_certificate_expiry #=> Boolean
resp.listeners[0].mutual_authentication.trust_store_association_status #=> String, one of "active", "removed"
resp.listeners[0].mutual_authentication.advertise_trust_store_ca_names #=> String, one of "on", "off"
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :listener_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the listeners.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



2589
2590
2591
2592
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2589

def describe_listeners(params = {}, options = {})
  req = build_request(:describe_listeners, params)
  req.send_request(options)
end

#describe_load_balancer_attributes(params = {}) ⇒ Types::DescribeLoadBalancerAttributesOutput

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

Examples:

Example: To describe load balancer attributes


# This example describes the attributes of the specified load balancer.

resp = client.describe_load_balancer_attributes({
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "access_logs.s3.enabled", 
      value: "false", 
    }, 
    {
      key: "idle_timeout.timeout_seconds", 
      value: "60", 
    }, 
    {
      key: "access_logs.s3.prefix", 
      value: "", 
    }, 
    {
      key: "deletion_protection.enabled", 
      value: "false", 
    }, 
    {
      key: "access_logs.s3.bucket", 
      value: "", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_load_balancer_attributes({
  load_balancer_arn: "LoadBalancerArn", # required
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

Returns:

See Also:



2670
2671
2672
2673
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2670

def describe_load_balancer_attributes(params = {}, options = {})
  req = build_request(:describe_load_balancer_attributes, params)
  req.send_request(options)
end

#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersOutput

Describes the specified load balancers or all of your load balancers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • load_balancer_available
  • load_balancer_exists
  • load_balancers_deleted

Examples:

Example: To describe a load balancer


# This example describes the specified load balancer.

resp = client.describe_load_balancers({
  load_balancer_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  ], 
})

resp.to_h outputs the following:
{
  load_balancers: [
    {
      availability_zones: [
        {
          subnet_id: "subnet-8360a9e7", 
          zone_name: "us-west-2a", 
        }, 
        {
          subnet_id: "subnet-b7d581c0", 
          zone_name: "us-west-2b", 
        }, 
      ], 
      canonical_hosted_zone_id: "Z2P70J7EXAMPLE", 
      created_time: Time.parse("2016-03-25T21:26:12.920Z"), 
      dns_name: "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      load_balancer_name: "my-load-balancer", 
      scheme: "internet-facing", 
      security_groups: [
        "sg-5943793c", 
      ], 
      state: {
        code: "active", 
      }, 
      type: "application", 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_load_balancers({
  load_balancer_arns: ["LoadBalancerArn"],
  names: ["LoadBalancerName"],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.load_balancers #=> Array
resp.load_balancers[0].load_balancer_arn #=> String
resp.load_balancers[0].dns_name #=> String
resp.load_balancers[0].canonical_hosted_zone_id #=> String
resp.load_balancers[0].created_time #=> Time
resp.load_balancers[0].load_balancer_name #=> String
resp.load_balancers[0].scheme #=> String, one of "internet-facing", "internal"
resp.load_balancers[0].vpc_id #=> String
resp.load_balancers[0].state.code #=> String, one of "active", "provisioning", "active_impaired", "failed"
resp.load_balancers[0].state.reason #=> String
resp.load_balancers[0].type #=> String, one of "application", "network", "gateway"
resp.load_balancers[0].availability_zones #=> Array
resp.load_balancers[0].availability_zones[0].zone_name #=> String
resp.load_balancers[0].availability_zones[0].subnet_id #=> String
resp.load_balancers[0].availability_zones[0].outpost_id #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses #=> Array
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].ip_address #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].allocation_id #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].private_i_pv_4_address #=> String
resp.load_balancers[0].availability_zones[0].load_balancer_addresses[0].i_pv_6_address #=> String
resp.load_balancers[0].availability_zones[0].source_nat_ipv_6_prefixes #=> Array
resp.load_balancers[0].availability_zones[0].source_nat_ipv_6_prefixes[0] #=> String
resp.load_balancers[0].security_groups #=> Array
resp.load_balancers[0].security_groups[0] #=> String
resp.load_balancers[0].ip_address_type #=> String, one of "ipv4", "dualstack", "dualstack-without-public-ipv4"
resp.load_balancers[0].customer_owned_ipv_4_pool #=> String
resp.load_balancers[0].enforce_security_group_inbound_rules_on_private_link_traffic #=> String
resp.load_balancers[0].enable_prefix_for_ipv_6_source_nat #=> String, one of "on", "off"
resp.load_balancers[0].ipam_pools.ipv_4_ipam_pool_id #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

  • :names (Array<String>) —

    The names of the load balancers.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



2794
2795
2796
2797
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2794

def describe_load_balancers(params = {}, options = {})
  req = build_request(:describe_load_balancers, params)
  req.send_request(options)
end

#describe_rules(params = {}) ⇒ Types::DescribeRulesOutput

Describes the specified rules or the rules for the specified listener. You must specify either a listener or rules.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a rule


# This example describes the specified rule.

resp = client.describe_rules({
  rule_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", 
  ], 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "path-pattern", 
          values: [
            "/img/*", 
          ], 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", 
    }, 
  ], 
}

Example: To describe rules for a Network Load Balancer listener


# This example describes the rules for the specified Network Load Balancer listener, including rules that route based on
# source IP address type.

resp = client.describe_rules({
  listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/net/my-nlb/1234567890abcdef/1234567890abcdef", 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "source-ip", 
          source_ip_config: {
            ip_address_type: "ipv4", 
          }, 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/aabbccdd11223344", 
    }, 
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv6-targets/abcdef1234567890", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "source-ip", 
          source_ip_config: {
            ip_address_type: "ipv6", 
          }, 
        }, 
      ], 
      is_default: false, 
      priority: "20", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/eeff00112233aabb", 
    }, 
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", 
          type: "forward", 
        }, 
      ], 
      conditions: [
      ], 
      is_default: true, 
      priority: "default", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/default", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_rules({
  listener_arn: "ListenerArn",
  rule_arns: ["RuleArn"],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.rules #=> Array
resp.rules[0].rule_arn #=> String
resp.rules[0].priority #=> String
resp.rules[0].conditions #=> Array
resp.rules[0].conditions[0].field #=> String
resp.rules[0].conditions[0].values #=> Array
resp.rules[0].conditions[0].values[0] #=> String
resp.rules[0].conditions[0].host_header_config.values #=> Array
resp.rules[0].conditions[0].host_header_config.values[0] #=> String
resp.rules[0].conditions[0].host_header_config.regex_values #=> Array
resp.rules[0].conditions[0].host_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.values #=> Array
resp.rules[0].conditions[0].path_pattern_config.values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.regex_values #=> Array
resp.rules[0].conditions[0].path_pattern_config.regex_values[0] #=> String
resp.rules[0].conditions[0].http_header_config.http_header_name #=> String
resp.rules[0].conditions[0].http_header_config.values #=> Array
resp.rules[0].conditions[0].http_header_config.values[0] #=> String
resp.rules[0].conditions[0].http_header_config.regex_values #=> Array
resp.rules[0].conditions[0].http_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].query_string_config.values #=> Array
resp.rules[0].conditions[0].query_string_config.values[0].key #=> String
resp.rules[0].conditions[0].query_string_config.values[0].value #=> String
resp.rules[0].conditions[0].http_request_method_config.values #=> Array
resp.rules[0].conditions[0].http_request_method_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.values #=> Array
resp.rules[0].conditions[0].source_ip_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.ip_address_type #=> String, one of "ipv4", "ipv6"
resp.rules[0].conditions[0].regex_values #=> Array
resp.rules[0].conditions[0].regex_values[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.rules[0].actions[0].target_group_arn #=> String
resp.rules[0].actions[0].authenticate_oidc_config.issuer #=> String
resp.rules[0].actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config. #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_id #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_secret #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_oidc_config.scope #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_cognito_config.scope #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].order #=> Integer
resp.rules[0].actions[0].redirect_config.protocol #=> String
resp.rules[0].actions[0].redirect_config.port #=> String
resp.rules[0].actions[0].redirect_config.host #=> String
resp.rules[0].actions[0].redirect_config.path #=> String
resp.rules[0].actions[0].redirect_config.query #=> String
resp.rules[0].actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.rules[0].actions[0].fixed_response_config.message_body #=> String
resp.rules[0].actions[0].fixed_response_config.status_code #=> String
resp.rules[0].actions[0].fixed_response_config.content_type #=> String
resp.rules[0].actions[0].forward_config.target_groups #=> Array
resp.rules[0].actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.rules[0].actions[0].forward_config.target_groups[0].weight #=> Integer
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.rules[0].actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.rules[0].actions[0].jwt_validation_config.issuer #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.rules[0].is_default #=> Boolean
resp.rules[0].transforms #=> Array
resp.rules[0].transforms[0].type #=> String, one of "host-header-rewrite", "url-rewrite"
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].replace #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].replace #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (String) —

    The Amazon Resource Name (ARN) of the listener.

  • :rule_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the rules.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



3027
3028
3029
3030
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3027

def describe_rules(params = {}, options = {})
  req = build_request(:describe_rules, params)
  req.send_request(options)
end

#describe_ssl_policies(params = {}) ⇒ Types::DescribeSSLPoliciesOutput

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.

Examples:

Example: To describe a policy used for SSL negotiation


# This example describes the specified policy used for SSL negotiation.

resp = client.describe_ssl_policies({
  names: [
    "ELBSecurityPolicy-2015-05", 
  ], 
})

resp.to_h outputs the following:
{
  ssl_policies: [
    {
      ciphers: [
        {
          name: "ECDHE-ECDSA-AES128-GCM-SHA256", 
          priority: 1, 
        }, 
        {
          name: "ECDHE-RSA-AES128-GCM-SHA256", 
          priority: 2, 
        }, 
        {
          name: "ECDHE-ECDSA-AES128-SHA256", 
          priority: 3, 
        }, 
        {
          name: "ECDHE-RSA-AES128-SHA256", 
          priority: 4, 
        }, 
        {
          name: "ECDHE-ECDSA-AES128-SHA", 
          priority: 5, 
        }, 
        {
          name: "ECDHE-RSA-AES128-SHA", 
          priority: 6, 
        }, 
        {
          name: "DHE-RSA-AES128-SHA", 
          priority: 7, 
        }, 
        {
          name: "ECDHE-ECDSA-AES256-GCM-SHA384", 
          priority: 8, 
        }, 
        {
          name: "ECDHE-RSA-AES256-GCM-SHA384", 
          priority: 9, 
        }, 
        {
          name: "ECDHE-ECDSA-AES256-SHA384", 
          priority: 10, 
        }, 
        {
          name: "ECDHE-RSA-AES256-SHA384", 
          priority: 11, 
        }, 
        {
          name: "ECDHE-RSA-AES256-SHA", 
          priority: 12, 
        }, 
        {
          name: "ECDHE-ECDSA-AES256-SHA", 
          priority: 13, 
        }, 
        {
          name: "AES128-GCM-SHA256", 
          priority: 14, 
        }, 
        {
          name: "AES128-SHA256", 
          priority: 15, 
        }, 
        {
          name: "AES128-SHA", 
          priority: 16, 
        }, 
        {
          name: "AES256-GCM-SHA384", 
          priority: 17, 
        }, 
        {
          name: "AES256-SHA256", 
          priority: 18, 
        }, 
        {
          name: "AES256-SHA", 
          priority: 19, 
        }, 
      ], 
      name: "ELBSecurityPolicy-2015-05", 
      ssl_protocols: [
        "TLSv1", 
        "TLSv1.1", 
        "TLSv1.2", 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_ssl_policies({
  names: ["SslPolicyName"],
  marker: "Marker",
  page_size: 1,
  load_balancer_type: "application", # accepts application, network, gateway
})

Response structure


resp.ssl_policies #=> Array
resp.ssl_policies[0].ssl_protocols #=> Array
resp.ssl_policies[0].ssl_protocols[0] #=> String
resp.ssl_policies[0].ciphers #=> Array
resp.ssl_policies[0].ciphers[0].name #=> String
resp.ssl_policies[0].ciphers[0].priority #=> Integer
resp.ssl_policies[0].name #=> String
resp.ssl_policies[0].supported_load_balancer_types #=> Array
resp.ssl_policies[0].supported_load_balancer_types[0] #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :names (Array<String>) —

    The names of the policies.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

  • :load_balancer_type (String) —

    The type of load balancer. The default lists the SSL policies for all load balancers.

Returns:

See Also:



3192
3193
3194
3195
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3192

def describe_ssl_policies(params = {}, options = {})
  req = build_request(:describe_ssl_policies, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::DescribeTagsOutput

Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Examples:

Example: To describe the tags assigned to a load balancer


# This example describes the tags assigned to the specified load balancer.

resp = client.describe_tags({
  resource_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  ], 
})

resp.to_h outputs the following:
{
  tag_descriptions: [
    {
      resource_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      tags: [
        {
          key: "project", 
          value: "lima", 
        }, 
        {
          key: "department", 
          value: "digital-media", 
        }, 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_tags({
  resource_arns: ["ResourceArn"], # required
})

Response structure


resp.tag_descriptions #=> Array
resp.tag_descriptions[0].resource_arn #=> String
resp.tag_descriptions[0].tags #=> Array
resp.tag_descriptions[0].tags[0].key #=> String
resp.tag_descriptions[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arns (required, Array<String>) —

    The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.

Returns:

See Also:



3258
3259
3260
3261
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3258

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_target_group_attributes(params = {}) ⇒ Types::DescribeTargetGroupAttributesOutput

Describes the attributes for the specified target group.

For more information, see the following:

Examples:

Example: To describe target group attributes


# This example describes the attributes of the specified target group.

resp = client.describe_target_group_attributes({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "stickiness.enabled", 
      value: "false", 
    }, 
    {
      key: "deregistration_delay.timeout_seconds", 
      value: "300", 
    }, 
    {
      key: "stickiness.type", 
      value: "lb_cookie", 
    }, 
    {
      key: "stickiness.lb_cookie.duration_seconds", 
      value: "86400", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_target_group_attributes({
  target_group_arn: "TargetGroupArn", # required
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

Returns:

See Also:



3334
3335
3336
3337
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3334

def describe_target_group_attributes(params = {}, options = {})
  req = build_request(:describe_target_group_attributes, params)
  req.send_request(options)
end

#describe_target_groups(params = {}) ⇒ Types::DescribeTargetGroupsOutput

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To describe a target group


# This example describes the specified target group.

resp = client.describe_target_groups({
  target_group_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  ], 
})

resp.to_h outputs the following:
{
  target_groups: [
    {
      health_check_interval_seconds: 30, 
      health_check_path: "/", 
      health_check_port: "traffic-port", 
      health_check_protocol: "HTTP", 
      health_check_timeout_seconds: 5, 
      healthy_threshold_count: 5, 
      load_balancer_arns: [
        "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      ], 
      matcher: {
        http_code: "200", 
      }, 
      port: 80, 
      protocol: "HTTP", 
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      target_group_name: "my-targets", 
      unhealthy_threshold_count: 2, 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_target_groups({
  load_balancer_arn: "LoadBalancerArn",
  target_group_arns: ["TargetGroupArn"],
  names: ["TargetGroupName"],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.target_groups #=> Array
resp.target_groups[0].target_group_arn #=> String
resp.target_groups[0].target_group_name #=> String
resp.target_groups[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].port #=> Integer
resp.target_groups[0].vpc_id #=> String
resp.target_groups[0].health_check_protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].health_check_port #=> String
resp.target_groups[0].health_check_enabled #=> Boolean
resp.target_groups[0].health_check_interval_seconds #=> Integer
resp.target_groups[0].health_check_timeout_seconds #=> Integer
resp.target_groups[0].healthy_threshold_count #=> Integer
resp.target_groups[0].unhealthy_threshold_count #=> Integer
resp.target_groups[0].health_check_path #=> String
resp.target_groups[0].matcher.http_code #=> String
resp.target_groups[0].matcher.grpc_code #=> String
resp.target_groups[0].load_balancer_arns #=> Array
resp.target_groups[0].load_balancer_arns[0] #=> String
resp.target_groups[0].target_type #=> String, one of "instance", "ip", "lambda", "alb"
resp.target_groups[0].protocol_version #=> String
resp.target_groups[0].ip_address_type #=> String, one of "ipv4", "ipv6"
resp.target_groups[0].target_control_port #=> Integer
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :target_group_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the target groups.

  • :names (Array<String>) —

    The names of the target groups.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



3445
3446
3447
3448
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3445

def describe_target_groups(params = {}, options = {})
  req = build_request(:describe_target_groups, params)
  req.send_request(options)
end

#describe_target_health(params = {}) ⇒ Types::DescribeTargetHealthOutput

Describes the health of the specified targets or all of your targets.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • target_deregistered
  • target_in_service

Examples:

Example: To describe the health of the targets for a target group


# This example describes the health of the targets for the specified target group. One target is healthy but the other is
# not specified in an action, so it can't receive traffic from the load balancer.

resp = client.describe_target_health({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
})

resp.to_h outputs the following:
{
  target_health_descriptions: [
    {
      target: {
        id: "i-0f76fade", 
        port: 80, 
      }, 
      target_health: {
        description: "Given target group is not configured to receive traffic from ELB", 
        reason: "Target.NotInUse", 
        state: "unused", 
      }, 
    }, 
    {
      health_check_port: "80", 
      target: {
        id: "i-0f76fade", 
        port: 80, 
      }, 
      target_health: {
        state: "healthy", 
      }, 
    }, 
  ], 
}

Example: To describe the health of a target


# This example describes the health of the specified target. This target is healthy.

resp = client.describe_target_health({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  targets: [
    {
      id: "i-0f76fade", 
      port: 80, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  target_health_descriptions: [
    {
      health_check_port: "80", 
      target: {
        id: "i-0f76fade", 
        port: 80, 
      }, 
      target_health: {
        state: "healthy", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_target_health({
  target_group_arn: "TargetGroupArn", # required
  targets: [
    {
      id: "TargetId", # required
      port: 1,
      availability_zone: "ZoneName",
      quic_server_id: "QuicServerId",
    },
  ],
  include: ["AnomalyDetection"], # accepts AnomalyDetection, All
})

Response structure


resp.target_health_descriptions #=> Array
resp.target_health_descriptions[0].target.id #=> String
resp.target_health_descriptions[0].target.port #=> Integer
resp.target_health_descriptions[0].target.availability_zone #=> String
resp.target_health_descriptions[0].target.quic_server_id #=> String
resp.target_health_descriptions[0].health_check_port #=> String
resp.target_health_descriptions[0].target_health.state #=> String, one of "initial", "healthy", "unhealthy", "unhealthy.draining", "unused", "draining", "unavailable"
resp.target_health_descriptions[0].target_health.reason #=> String, one of "Elb.RegistrationInProgress", "Elb.InitialHealthChecking", "Target.ResponseCodeMismatch", "Target.Timeout", "Target.FailedHealthChecks", "Target.NotRegistered", "Target.NotInUse", "Target.DeregistrationInProgress", "Target.InvalidState", "Target.IpUnusable", "Target.HealthCheckDisabled", "Elb.InternalError"
resp.target_health_descriptions[0].target_health.description #=> String
resp.target_health_descriptions[0].anomaly_detection.result #=> String, one of "anomalous", "normal"
resp.target_health_descriptions[0].anomaly_detection.mitigation_in_effect #=> String, one of "yes", "no"
resp.target_health_descriptions[0].administrative_override.state #=> String, one of "unknown", "no_override", "zonal_shift_active", "zonal_shift_delegated_to_dns"
resp.target_health_descriptions[0].administrative_override.reason #=> String, one of "AdministrativeOverride.Unknown", "AdministrativeOverride.NoOverride", "AdministrativeOverride.ZonalShiftActive", "AdministrativeOverride.ZonalShiftDelegatedToDns"
resp.target_health_descriptions[0].administrative_override.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

  • :targets (Array<Types::TargetDescription>) —

    The targets.

  • :include (Array<String>) —

    Used to include anomaly detection information.

Returns:

See Also:



3574
3575
3576
3577
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3574

def describe_target_health(params = {}, options = {})
  req = build_request(:describe_target_health, params)
  req.send_request(options)
end

#describe_trust_store_associations(params = {}) ⇒ Types::DescribeTrustStoreAssociationsOutput

Describes all resources associated with the specified trust store.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_trust_store_associations({
  trust_store_arn: "TrustStoreArn", # required
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.trust_store_associations #=> Array
resp.trust_store_associations[0].resource_arn #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



3616
3617
3618
3619
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3616

def describe_trust_store_associations(params = {}, options = {})
  req = build_request(:describe_trust_store_associations, params)
  req.send_request(options)
end

#describe_trust_store_revocations(params = {}) ⇒ Types::DescribeTrustStoreRevocationsOutput

Describes the revocation files in use by the specified trust store or revocation files.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_trust_store_revocations({
  trust_store_arn: "TrustStoreArn", # required
  revocation_ids: [1],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.trust_store_revocations #=> Array
resp.trust_store_revocations[0].trust_store_arn #=> String
resp.trust_store_revocations[0].revocation_id #=> Integer
resp.trust_store_revocations[0].revocation_type #=> String, one of "CRL"
resp.trust_store_revocations[0].number_of_revoked_entries #=> Integer
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :revocation_ids (Array<Integer>) —

    The revocation IDs of the revocation files you want to describe.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



3666
3667
3668
3669
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3666

def describe_trust_store_revocations(params = {}, options = {})
  req = build_request(:describe_trust_store_revocations, params)
  req.send_request(options)
end

#describe_trust_stores(params = {}) ⇒ Types::DescribeTrustStoresOutput

Describes all trust stores for the specified account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_trust_stores({
  trust_store_arns: ["TrustStoreArn"],
  names: ["TrustStoreName"],
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.trust_stores #=> Array
resp.trust_stores[0].name #=> String
resp.trust_stores[0].trust_store_arn #=> String
resp.trust_stores[0].status #=> String, one of "ACTIVE", "CREATING"
resp.trust_stores[0].number_of_ca_certificates #=> Integer
resp.trust_stores[0].total_revoked_entries #=> Integer
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arns (Array<String>) —

    The Amazon Resource Name (ARN) of the trust store.

  • :names (Array<String>) —

    The names of the trust stores.

  • :marker (String) —

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer) —

    The maximum number of results to return with this call.

Returns:

See Also:



3716
3717
3718
3719
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3716

def describe_trust_stores(params = {}, options = {})
  req = build_request(:describe_trust_stores, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput

Retrieves the resource policy for a specified resource.

Examples:

Example: Retrieve a resource policy


# This example retrieves the resource policy for the specified trust store.

resp = client.get_resource_policy({
  resource_arn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:truststore/my-trust-store/73e2d6bc24d8a067", 
})

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



3753
3754
3755
3756
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3753

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

#get_trust_store_ca_certificates_bundle(params = {}) ⇒ Types::GetTrustStoreCaCertificatesBundleOutput

Retrieves the ca certificate bundle.

This action returns a pre-signed S3 URI which is active for ten minutes.

Examples:

Request syntax with placeholder values


resp = client.get_trust_store_ca_certificates_bundle({
  trust_store_arn: "TrustStoreArn", # required
})

Response structure


resp.location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

Returns:

See Also:



3784
3785
3786
3787
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3784

def get_trust_store_ca_certificates_bundle(params = {}, options = {})
  req = build_request(:get_trust_store_ca_certificates_bundle, params)
  req.send_request(options)
end

#get_trust_store_revocation_content(params = {}) ⇒ Types::GetTrustStoreRevocationContentOutput

Retrieves the specified revocation file.

This action returns a pre-signed S3 URI which is active for ten minutes.

Examples:

Request syntax with placeholder values


resp = client.get_trust_store_revocation_content({
  trust_store_arn: "TrustStoreArn", # required
  revocation_id: 1, # required
})

Response structure


resp.location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :revocation_id (required, Integer) —

    The revocation ID of the revocation file.

Returns:

See Also:



3819
3820
3821
3822
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3819

def get_trust_store_revocation_content(params = {}, options = {})
  req = build_request(:get_trust_store_revocation_content, params)
  req.send_request(options)
end

#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationOutput

Modifies the capacity reservation of the specified load balancer.

When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity or ResetCapacityReservation.

Examples:

Request syntax with placeholder values


resp = client.modify_capacity_reservation({
  load_balancer_arn: "LoadBalancerArn", # required
  minimum_load_balancer_capacity: {
    capacity_units: 1,
  },
  reset_capacity_reservation: false,
})

Response structure


resp.last_modified_time #=> Time
resp.decrease_requests_remaining #=> Integer
resp.minimum_load_balancer_capacity.capacity_units #=> Integer
resp.capacity_reservation_state #=> Array
resp.capacity_reservation_state[0].state.code #=> String, one of "provisioned", "pending", "rebalancing", "failed"
resp.capacity_reservation_state[0].state.reason #=> String
resp.capacity_reservation_state[0].availability_zone #=> String
resp.capacity_reservation_state[0].effective_capacity_units #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :minimum_load_balancer_capacity (Types::MinimumLoadBalancerCapacity) —

    The minimum load balancer capacity reserved.

  • :reset_capacity_reservation (Boolean) —

    Resets the capacity reservation.

Returns:

See Also:



3870
3871
3872
3873
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3870

def modify_capacity_reservation(params = {}, options = {})
  req = build_request(:modify_capacity_reservation, params)
  req.send_request(options)
end

#modify_ip_pools(params = {}) ⇒ Types::ModifyIpPoolsOutput

[Application Load Balancers] Modify the IP pool associated to a load balancer.

Examples:

Request syntax with placeholder values


resp = client.modify_ip_pools({
  load_balancer_arn: "LoadBalancerArn", # required
  ipam_pools: {
    ipv_4_ipam_pool_id: "IpamPoolId",
  },
  remove_ipam_pools: ["ipv4"], # accepts ipv4
})

Response structure


resp.ipam_pools.ipv_4_ipam_pool_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :ipam_pools (Types::IpamPools) —

    The IPAM pools to be modified.

  • :remove_ipam_pools (Array<String>) —

    Remove the IP pools in use by the load balancer.

Returns:

See Also:



3909
3910
3911
3912
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3909

def modify_ip_pools(params = {}, options = {})
  req = build_request(:modify_ip_pools, params)
  req.send_request(options)
end

#modify_listener(params = {}) ⇒ Types::ModifyListenerOutput

Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Examples:

Example: To change the default action for a listener


# This example changes the default action for the specified listener.

resp = client.modify_listener({
  default_actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", 
      type: "forward", 
    }, 
  ], 
  listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
})

resp.to_h outputs the following:
{
  listeners: [
    {
      default_actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", 
          type: "forward", 
        }, 
      ], 
      listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      port: 80, 
      protocol: "HTTP", 
    }, 
  ], 
}

Example: To change the server certificate


# This example changes the server certificate for the specified HTTPS listener.

resp = client.modify_listener({
  certificates: [
    {
      certificate_arn: "arn:aws:iam::123456789012:server-certificate/my-new-server-cert", 
    }, 
  ], 
  listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", 
})

resp.to_h outputs the following:
{
  listeners: [
    {
      certificates: [
        {
          certificate_arn: "arn:aws:iam::123456789012:server-certificate/my-new-server-cert", 
        }, 
      ], 
      default_actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      listener_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", 
      load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      port: 443, 
      protocol: "HTTPS", 
      ssl_policy: "ELBSecurityPolicy-2015-05", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.modify_listener({
  listener_arn: "ListenerArn", # required
  port: 1,
  protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE, QUIC, TCP_QUIC
  ssl_policy: "SslPolicyName",
  certificates: [
    {
      certificate_arn: "CertificateArn",
      is_default: false,
    },
  ],
  default_actions: [
    {
      type: "forward", # required, accepts forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response, jwt-validation
      target_group_arn: "TargetGroupArn",
      authenticate_oidc_config: {
        issuer: "AuthenticateOidcActionIssuer", # required
        authorization_endpoint: "AuthenticateOidcActionAuthorizationEndpoint", # required
        token_endpoint: "AuthenticateOidcActionTokenEndpoint", # required
        user_info_endpoint: "AuthenticateOidcActionUserInfoEndpoint", # required
        client_id: "AuthenticateOidcActionClientId", # required
        client_secret: "AuthenticateOidcActionClientSecret",
        session_cookie_name: "AuthenticateOidcActionSessionCookieName",
        scope: "AuthenticateOidcActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateOidcActionAuthenticationRequestParamName" => "AuthenticateOidcActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
        use_existing_client_secret: false,
      },
      authenticate_cognito_config: {
        user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
        user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
        user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
        session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
        scope: "AuthenticateCognitoActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
      },
      order: 1,
      redirect_config: {
        protocol: "RedirectActionProtocol",
        port: "RedirectActionPort",
        host: "RedirectActionHost",
        path: "RedirectActionPath",
        query: "RedirectActionQuery",
        status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
      },
      fixed_response_config: {
        message_body: "FixedResponseActionMessage",
        status_code: "FixedResponseActionStatusCode", # required
        content_type: "FixedResponseActionContentType",
      },
      forward_config: {
        target_groups: [
          {
            target_group_arn: "TargetGroupArn",
            weight: 1,
          },
        ],
        target_group_stickiness_config: {
          enabled: false,
          duration_seconds: 1,
        },
      },
      jwt_validation_config: {
        jwks_endpoint: "JwtValidationActionJwksEndpoint", # required
        issuer: "JwtValidationActionIssuer", # required
        additional_claims: [
          {
            format: "single-string", # required, accepts single-string, string-array, space-separated-values
            name: "JwtValidationActionAdditionalClaimName", # required
            values: ["JwtValidationActionAdditionalClaimValue"], # required
          },
        ],
      },
    },
  ],
  alpn_policy: ["AlpnPolicyValue"],
  mutual_authentication: {
    mode: "Mode",
    trust_store_arn: "TrustStoreArn",
    ignore_client_certificate_expiry: false,
    trust_store_association_status: "active", # accepts active, removed
    advertise_trust_store_ca_names: "on", # accepts on, off
  },
})

Response structure


resp.listeners #=> Array
resp.listeners[0].listener_arn #=> String
resp.listeners[0].load_balancer_arn #=> String
resp.listeners[0].port #=> Integer
resp.listeners[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.listeners[0].certificates #=> Array
resp.listeners[0].certificates[0].certificate_arn #=> String
resp.listeners[0].certificates[0].is_default #=> Boolean
resp.listeners[0].ssl_policy #=> String
resp.listeners[0].default_actions #=> Array
resp.listeners[0].default_actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.listeners[0].default_actions[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.issuer #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config. #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_id #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.client_secret #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.scope #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.listeners[0].default_actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.listeners[0].default_actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.listeners[0].default_actions[0].order #=> Integer
resp.listeners[0].default_actions[0].redirect_config.protocol #=> String
resp.listeners[0].default_actions[0].redirect_config.port #=> String
resp.listeners[0].default_actions[0].redirect_config.host #=> String
resp.listeners[0].default_actions[0].redirect_config.path #=> String
resp.listeners[0].default_actions[0].redirect_config.query #=> String
resp.listeners[0].default_actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.listeners[0].default_actions[0].fixed_response_config.message_body #=> String
resp.listeners[0].default_actions[0].fixed_response_config.status_code #=> String
resp.listeners[0].default_actions[0].fixed_response_config.content_type #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups #=> Array
resp.listeners[0].default_actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.listeners[0].default_actions[0].forward_config.target_groups[0].weight #=> Integer
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.listeners[0].default_actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.listeners[0].default_actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.issuer #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.listeners[0].default_actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.listeners[0].alpn_policy #=> Array
resp.listeners[0].alpn_policy[0] #=> String
resp.listeners[0].mutual_authentication.mode #=> String
resp.listeners[0].mutual_authentication.trust_store_arn #=> String
resp.listeners[0].mutual_authentication.ignore_client_certificate_expiry #=> Boolean
resp.listeners[0].mutual_authentication.trust_store_association_status #=> String, one of "active", "removed"
resp.listeners[0].mutual_authentication.advertise_trust_store_ca_names #=> String, one of "on", "off"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :port (Integer) —

    The port for connections from clients to the load balancer. You can't specify a port for a Gateway Load Balancer.

  • :protocol (String) —

    The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols. You can’t change the protocol to UDP, TCP_UDP, QUIC, or TCP_QUIC if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.

  • :ssl_policy (String) —

    [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

    For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.

  • :certificates (Array<Types::Certificate>) —

    [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

  • :default_actions (Array<Types::Action>) —

    The actions for the default rule.

  • :alpn_policy (Array<String>) —

    [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

    • HTTP1Only

    • HTTP2Only

    • HTTP2Optional

    • HTTP2Preferred

    • None

    For more information, see ALPN policies in the Network Load Balancers Guide.

  • :mutual_authentication (Types::MutualAuthenticationAttributes) —

    [HTTPS listeners] The mutual authentication configuration information.

Returns:

See Also:



4227
4228
4229
4230
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4227

def modify_listener(params = {}, options = {})
  req = build_request(:modify_listener, params)
  req.send_request(options)
end

#modify_listener_attributes(params = {}) ⇒ Types::ModifyListenerAttributesOutput

Modifies the specified attributes of the specified listener.

Examples:

Request syntax with placeholder values


resp = client.modify_listener_attributes({
  listener_arn: "ListenerArn", # required
  attributes: [ # required
    {
      key: "ListenerAttributeKey",
      value: "ListenerAttributeValue",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :attributes (required, Array<Types::ListenerAttribute>) —

    The listener attributes.

Returns:

See Also:



4266
4267
4268
4269
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4266

def modify_listener_attributes(params = {}, options = {})
  req = build_request(:modify_listener_attributes, params)
  req.send_request(options)
end

#modify_load_balancer_attributes(params = {}) ⇒ Types::ModifyLoadBalancerAttributesOutput

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

Examples:

Example: To enable deletion protection


# This example enables deletion protection for the specified load balancer.

resp = client.modify_load_balancer_attributes({
  attributes: [
    {
      key: "deletion_protection.enabled", 
      value: "true", 
    }, 
  ], 
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "deletion_protection.enabled", 
      value: "true", 
    }, 
    {
      key: "access_logs.s3.enabled", 
      value: "false", 
    }, 
    {
      key: "idle_timeout.timeout_seconds", 
      value: "60", 
    }, 
    {
      key: "access_logs.s3.prefix", 
      value: "", 
    }, 
    {
      key: "access_logs.s3.bucket", 
      value: "", 
    }, 
  ], 
}

Example: To change the idle timeout


# This example changes the idle timeout value for the specified load balancer.

resp = client.modify_load_balancer_attributes({
  attributes: [
    {
      key: "idle_timeout.timeout_seconds", 
      value: "30", 
    }, 
  ], 
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "idle_timeout.timeout_seconds", 
      value: "30", 
    }, 
    {
      key: "access_logs.s3.enabled", 
      value: "false", 
    }, 
    {
      key: "access_logs.s3.prefix", 
      value: "", 
    }, 
    {
      key: "deletion_protection.enabled", 
      value: "true", 
    }, 
    {
      key: "access_logs.s3.bucket", 
      value: "", 
    }, 
  ], 
}

Example: To enable access logs


# This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region
# as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.

resp = client.modify_load_balancer_attributes({
  attributes: [
    {
      key: "access_logs.s3.enabled", 
      value: "true", 
    }, 
    {
      key: "access_logs.s3.bucket", 
      value: "my-loadbalancer-logs", 
    }, 
    {
      key: "access_logs.s3.prefix", 
      value: "myapp", 
    }, 
  ], 
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "access_logs.s3.enabled", 
      value: "true", 
    }, 
    {
      key: "access_logs.s3.bucket", 
      value: "my-load-balancer-logs", 
    }, 
    {
      key: "access_logs.s3.prefix", 
      value: "myapp", 
    }, 
    {
      key: "idle_timeout.timeout_seconds", 
      value: "60", 
    }, 
    {
      key: "deletion_protection.enabled", 
      value: "false", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.modify_load_balancer_attributes({
  load_balancer_arn: "LoadBalancerArn", # required
  attributes: [ # required
    {
      key: "LoadBalancerAttributeKey",
      value: "LoadBalancerAttributeValue",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :attributes (required, Array<Types::LoadBalancerAttribute>) —

    The load balancer attributes.

Returns:

See Also:



4440
4441
4442
4443
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4440

def modify_load_balancer_attributes(params = {}, options = {})
  req = build_request(:modify_load_balancer_attributes, params)
  req.send_request(options)
end

#modify_rule(params = {}) ⇒ Types::ModifyRuleOutput

Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Examples:

Example: To modify a rule


# This example modifies the condition for the specified rule.

resp = client.modify_rule({
  conditions: [
    {
      field: "path-pattern", 
      values: [
        "/images/*", 
      ], 
    }, 
  ], 
  rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "path-pattern", 
          values: [
            "/images/*", 
          ], 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", 
    }, 
  ], 
}

Example: To modify a Network Load Balancer listener rule


# This example modifies an NLB listener rule to forward traffic to a different target group.

resp = client.modify_rule({
  actions: [
    {
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-ipv4-targets/1234567890abcdef", 
      type: "forward", 
    }, 
  ], 
  rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-ipv4-targets/1234567890abcdef", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "source-ip", 
          source_ip_config: {
            ip_address_type: "ipv4", 
          }, 
        }, 
      ], 
      is_default: false, 
      priority: "10", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.modify_rule({
  rule_arn: "RuleArn", # required
  conditions: [
    {
      field: "ConditionFieldName",
      values: ["StringValue"],
      host_header_config: {
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      path_pattern_config: {
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      http_header_config: {
        http_header_name: "HttpHeaderConditionName",
        values: ["StringValue"],
        regex_values: ["StringValue"],
      },
      query_string_config: {
        values: [
          {
            key: "StringValue",
            value: "StringValue",
          },
        ],
      },
      http_request_method_config: {
        values: ["StringValue"],
      },
      source_ip_config: {
        values: ["StringValue"],
        ip_address_type: "ipv4", # accepts ipv4, ipv6
      },
      regex_values: ["StringValue"],
    },
  ],
  actions: [
    {
      type: "forward", # required, accepts forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response, jwt-validation
      target_group_arn: "TargetGroupArn",
      authenticate_oidc_config: {
        issuer: "AuthenticateOidcActionIssuer", # required
        authorization_endpoint: "AuthenticateOidcActionAuthorizationEndpoint", # required
        token_endpoint: "AuthenticateOidcActionTokenEndpoint", # required
        user_info_endpoint: "AuthenticateOidcActionUserInfoEndpoint", # required
        client_id: "AuthenticateOidcActionClientId", # required
        client_secret: "AuthenticateOidcActionClientSecret",
        session_cookie_name: "AuthenticateOidcActionSessionCookieName",
        scope: "AuthenticateOidcActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateOidcActionAuthenticationRequestParamName" => "AuthenticateOidcActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
        use_existing_client_secret: false,
      },
      authenticate_cognito_config: {
        user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
        user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
        user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
        session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
        scope: "AuthenticateCognitoActionScope",
        session_timeout: 1,
        authentication_request_extra_params: {
          "AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
        },
        on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
      },
      order: 1,
      redirect_config: {
        protocol: "RedirectActionProtocol",
        port: "RedirectActionPort",
        host: "RedirectActionHost",
        path: "RedirectActionPath",
        query: "RedirectActionQuery",
        status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
      },
      fixed_response_config: {
        message_body: "FixedResponseActionMessage",
        status_code: "FixedResponseActionStatusCode", # required
        content_type: "FixedResponseActionContentType",
      },
      forward_config: {
        target_groups: [
          {
            target_group_arn: "TargetGroupArn",
            weight: 1,
          },
        ],
        target_group_stickiness_config: {
          enabled: false,
          duration_seconds: 1,
        },
      },
      jwt_validation_config: {
        jwks_endpoint: "JwtValidationActionJwksEndpoint", # required
        issuer: "JwtValidationActionIssuer", # required
        additional_claims: [
          {
            format: "single-string", # required, accepts single-string, string-array, space-separated-values
            name: "JwtValidationActionAdditionalClaimName", # required
            values: ["JwtValidationActionAdditionalClaimValue"], # required
          },
        ],
      },
    },
  ],
  transforms: [
    {
      type: "host-header-rewrite", # required, accepts host-header-rewrite, url-rewrite
      host_header_rewrite_config: {
        rewrites: [
          {
            regex: "StringValue", # required
            replace: "StringValue", # required
          },
        ],
      },
      url_rewrite_config: {
        rewrites: [
          {
            regex: "StringValue", # required
            replace: "StringValue", # required
          },
        ],
      },
    },
  ],
  reset_transforms: false,
})

Response structure


resp.rules #=> Array
resp.rules[0].rule_arn #=> String
resp.rules[0].priority #=> String
resp.rules[0].conditions #=> Array
resp.rules[0].conditions[0].field #=> String
resp.rules[0].conditions[0].values #=> Array
resp.rules[0].conditions[0].values[0] #=> String
resp.rules[0].conditions[0].host_header_config.values #=> Array
resp.rules[0].conditions[0].host_header_config.values[0] #=> String
resp.rules[0].conditions[0].host_header_config.regex_values #=> Array
resp.rules[0].conditions[0].host_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.values #=> Array
resp.rules[0].conditions[0].path_pattern_config.values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.regex_values #=> Array
resp.rules[0].conditions[0].path_pattern_config.regex_values[0] #=> String
resp.rules[0].conditions[0].http_header_config.http_header_name #=> String
resp.rules[0].conditions[0].http_header_config.values #=> Array
resp.rules[0].conditions[0].http_header_config.values[0] #=> String
resp.rules[0].conditions[0].http_header_config.regex_values #=> Array
resp.rules[0].conditions[0].http_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].query_string_config.values #=> Array
resp.rules[0].conditions[0].query_string_config.values[0].key #=> String
resp.rules[0].conditions[0].query_string_config.values[0].value #=> String
resp.rules[0].conditions[0].http_request_method_config.values #=> Array
resp.rules[0].conditions[0].http_request_method_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.values #=> Array
resp.rules[0].conditions[0].source_ip_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.ip_address_type #=> String, one of "ipv4", "ipv6"
resp.rules[0].conditions[0].regex_values #=> Array
resp.rules[0].conditions[0].regex_values[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.rules[0].actions[0].target_group_arn #=> String
resp.rules[0].actions[0].authenticate_oidc_config.issuer #=> String
resp.rules[0].actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config. #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_id #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_secret #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_oidc_config.scope #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_cognito_config.scope #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].order #=> Integer
resp.rules[0].actions[0].redirect_config.protocol #=> String
resp.rules[0].actions[0].redirect_config.port #=> String
resp.rules[0].actions[0].redirect_config.host #=> String
resp.rules[0].actions[0].redirect_config.path #=> String
resp.rules[0].actions[0].redirect_config.query #=> String
resp.rules[0].actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.rules[0].actions[0].fixed_response_config.message_body #=> String
resp.rules[0].actions[0].fixed_response_config.status_code #=> String
resp.rules[0].actions[0].fixed_response_config.content_type #=> String
resp.rules[0].actions[0].forward_config.target_groups #=> Array
resp.rules[0].actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.rules[0].actions[0].forward_config.target_groups[0].weight #=> Integer
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.rules[0].actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.rules[0].actions[0].jwt_validation_config.issuer #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.rules[0].is_default #=> Boolean
resp.rules[0].transforms #=> Array
resp.rules[0].transforms[0].type #=> String, one of "host-header-rewrite", "url-rewrite"
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].replace #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].replace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_arn (required, String) —

    The Amazon Resource Name (ARN) of the rule.

  • :conditions (Array<Types::RuleCondition>) —

    The conditions.

  • :actions (Array<Types::Action>) —

    The actions.

  • :transforms (Array<Types::RuleTransform>) —

    The transforms to apply to requests that match this rule. You can add one host header rewrite transform and one URL rewrite transform. If you specify Transforms, you can't specify ResetTransforms.

  • :reset_transforms (Boolean) —

    Indicates whether to remove all transforms from the rule. If you specify ResetTransforms, you can't specify Transforms.

Returns:

See Also:



4783
4784
4785
4786
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4783

def modify_rule(params = {}, options = {})
  req = build_request(:modify_rule, params)
  req.send_request(options)
end

#modify_target_group(params = {}) ⇒ Types::ModifyTargetGroupOutput

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Examples:

Example: To modify the health check configuration for a target group


# This example changes the configuration of the health checks used to evaluate the health of the targets for the specified
# target group.

resp = client.modify_target_group({
  health_check_port: "443", 
  health_check_protocol: "HTTPS", 
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", 
})

resp.to_h outputs the following:
{
  target_groups: [
    {
      health_check_interval_seconds: 30, 
      health_check_port: "443", 
      health_check_protocol: "HTTPS", 
      health_check_timeout_seconds: 5, 
      healthy_threshold_count: 5, 
      load_balancer_arns: [
        "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      ], 
      matcher: {
        http_code: "200", 
      }, 
      port: 443, 
      protocol: "HTTPS", 
      target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", 
      target_group_name: "my-https-targets", 
      unhealthy_threshold_count: 2, 
      vpc_id: "vpc-3ac0fb5f", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.modify_target_group({
  target_group_arn: "TargetGroupArn", # required
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE, QUIC, TCP_QUIC
  health_check_port: "HealthCheckPort",
  health_check_path: "Path",
  health_check_enabled: false,
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode",
    grpc_code: "GrpcCode",
  },
})

Response structure


resp.target_groups #=> Array
resp.target_groups[0].target_group_arn #=> String
resp.target_groups[0].target_group_name #=> String
resp.target_groups[0].protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].port #=> Integer
resp.target_groups[0].vpc_id #=> String
resp.target_groups[0].health_check_protocol #=> String, one of "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC"
resp.target_groups[0].health_check_port #=> String
resp.target_groups[0].health_check_enabled #=> Boolean
resp.target_groups[0].health_check_interval_seconds #=> Integer
resp.target_groups[0].health_check_timeout_seconds #=> Integer
resp.target_groups[0].healthy_threshold_count #=> Integer
resp.target_groups[0].unhealthy_threshold_count #=> Integer
resp.target_groups[0].health_check_path #=> String
resp.target_groups[0].matcher.http_code #=> String
resp.target_groups[0].matcher.grpc_code #=> String
resp.target_groups[0].load_balancer_arns #=> Array
resp.target_groups[0].load_balancer_arns[0] #=> String
resp.target_groups[0].target_type #=> String, one of "instance", "ip", "lambda", "alb"
resp.target_groups[0].protocol_version #=> String
resp.target_groups[0].ip_address_type #=> String, one of "ipv4", "ipv6"
resp.target_groups[0].target_control_port #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

  • :health_check_protocol (String) —

    The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

  • :health_check_port (String) —

    The port the load balancer uses when performing health checks on targets.

  • :health_check_path (String) —

    [HTTP/HTTPS health checks] The destination for health checks on the targets.

    [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

    [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

  • :health_check_enabled (Boolean) —

    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and can't be disabled.

  • :health_check_interval_seconds (Integer) —

    The approximate amount of time, in seconds, between health checks of an individual target.

  • :health_check_timeout_seconds (Integer) —

    [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

  • :healthy_threshold_count (Integer) —

    The number of consecutive health checks successes required before considering an unhealthy target healthy.

  • :unhealthy_threshold_count (Integer) —

    The number of consecutive health check failures required before considering the target unhealthy.

  • :matcher (Types::Matcher) —

    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

Returns:

See Also:



4935
4936
4937
4938
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4935

def modify_target_group(params = {}, options = {})
  req = build_request(:modify_target_group, params)
  req.send_request(options)
end

#modify_target_group_attributes(params = {}) ⇒ Types::ModifyTargetGroupAttributesOutput

Modifies the specified attributes of the specified target group.

Examples:

Example: To modify the deregistration delay timeout


# This example sets the deregistration delay timeout to the specified value for the specified target group.

resp = client.modify_target_group_attributes({
  attributes: [
    {
      key: "deregistration_delay.timeout_seconds", 
      value: "600", 
    }, 
  ], 
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
})

resp.to_h outputs the following:
{
  attributes: [
    {
      key: "stickiness.enabled", 
      value: "false", 
    }, 
    {
      key: "deregistration_delay.timeout_seconds", 
      value: "600", 
    }, 
    {
      key: "stickiness.type", 
      value: "lb_cookie", 
    }, 
    {
      key: "stickiness.lb_cookie.duration_seconds", 
      value: "86400", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.modify_target_group_attributes({
  target_group_arn: "TargetGroupArn", # required
  attributes: [ # required
    {
      key: "TargetGroupAttributeKey",
      value: "TargetGroupAttributeValue",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].key #=> String
resp.attributes[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

  • :attributes (required, Array<Types::TargetGroupAttribute>) —

    The target group attributes.

Returns:

See Also:



5011
5012
5013
5014
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5011

def modify_target_group_attributes(params = {}, options = {})
  req = build_request(:modify_target_group_attributes, params)
  req.send_request(options)
end

#modify_trust_store(params = {}) ⇒ Types::ModifyTrustStoreOutput

Update the ca certificate bundle for the specified trust store.

Examples:

Request syntax with placeholder values


resp = client.modify_trust_store({
  trust_store_arn: "TrustStoreArn", # required
  ca_certificates_bundle_s3_bucket: "S3Bucket", # required
  ca_certificates_bundle_s3_key: "S3Key", # required
  ca_certificates_bundle_s3_object_version: "S3ObjectVersion",
})

Response structure


resp.trust_stores #=> Array
resp.trust_stores[0].name #=> String
resp.trust_stores[0].trust_store_arn #=> String
resp.trust_stores[0].status #=> String, one of "ACTIVE", "CREATING"
resp.trust_stores[0].number_of_ca_certificates #=> Integer
resp.trust_stores[0].total_revoked_entries #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :ca_certificates_bundle_s3_bucket (required, String) —

    The Amazon S3 bucket for the ca certificates bundle.

  • :ca_certificates_bundle_s3_key (required, String) —

    The Amazon S3 path for the ca certificates bundle.

  • :ca_certificates_bundle_s3_object_version (String) —

    The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

Returns:

See Also:



5057
5058
5059
5060
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5057

def modify_trust_store(params = {}, options = {})
  req = build_request(:modify_trust_store, params)
  req.send_request(options)
end

#register_targets(params = {}) ⇒ Struct

Registers the specified targets with the specified target group.

If the target is an EC2 instance, it must be in the running state when you register it.

By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

For more information, see the following:

Examples:

Example: To register targets with a target group


# This example registers the specified instances with the specified target group.

resp = client.register_targets({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  targets: [
    {
      id: "i-80c8dd94", 
    }, 
    {
      id: "i-ceddcd4d", 
    }, 
  ], 
})

Example: To register targets with a target group using port overrides


# This example registers the specified instance with the specified target group using multiple ports. This enables you to
# register ECS containers on the same instance as targets in the target group.

resp = client.register_targets({
  target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", 
  targets: [
    {
      id: "i-80c8dd94", 
      port: 80, 
    }, 
    {
      id: "i-80c8dd94", 
      port: 766, 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.register_targets({
  target_group_arn: "TargetGroupArn", # required
  targets: [ # required
    {
      id: "TargetId", # required
      port: 1,
      availability_zone: "ZoneName",
      quic_server_id: "QuicServerId",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the target group.

  • :targets (required, Array<Types::TargetDescription>) —

    The targets.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5149
5150
5151
5152
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5149

def register_targets(params = {}, options = {})
  req = build_request(:register_targets, params)
  req.send_request(options)
end

#remove_listener_certificates(params = {}) ⇒ Struct

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

Examples:

Request syntax with placeholder values


resp = client.remove_listener_certificates({
  listener_arn: "ListenerArn", # required
  certificates: [ # required
    {
      certificate_arn: "CertificateArn",
      is_default: false,
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :certificates (required, Array<Types::Certificate>) —

    The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5183
5184
5185
5186
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5183

def remove_listener_certificates(params = {}, options = {})
  req = build_request(:remove_listener_certificates, params)
  req.send_request(options)
end

#remove_tags(params = {}) ⇒ Struct

Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Examples:

Example: To remove tags from a load balancer


# This example removes the specified tags from the specified load balancer.

resp = client.remove_tags({
  resource_arns: [
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  ], 
  tag_keys: [
    "project", 
    "department", 
  ], 
})

Request syntax with placeholder values


resp = client.remove_tags({
  resource_arns: ["ResourceArn"], # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arns (required, Array<String>) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys for the tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5227
5228
5229
5230
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5227

def remove_tags(params = {}, options = {})
  req = build_request(:remove_tags, params)
  req.send_request(options)
end

#remove_trust_store_revocations(params = {}) ⇒ Struct

Removes the specified revocation file from the specified trust store.

Examples:

Request syntax with placeholder values


resp = client.remove_trust_store_revocations({
  trust_store_arn: "TrustStoreArn", # required
  revocation_ids: [1], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the trust store.

  • :revocation_ids (required, Array<Integer>) —

    The revocation IDs of the revocation files you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5253
5254
5255
5256
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5253

def remove_trust_store_revocations(params = {}, options = {})
  req = build_request(:remove_trust_store_revocations, params)
  req.send_request(options)
end

#set_ip_address_type(params = {}) ⇒ Types::SetIpAddressTypeOutput

Sets the type of IP addresses used by the subnets of the specified load balancer.

Examples:

Request syntax with placeholder values


resp = client.set_ip_address_type({
  load_balancer_arn: "LoadBalancerArn", # required
  ip_address_type: "ipv4", # required, accepts ipv4, dualstack, dualstack-without-public-ipv4
})

Response structure


resp.ip_address_type #=> String, one of "ipv4", "dualstack", "dualstack-without-public-ipv4"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :ip_address_type (required, String) —

    The IP address type. Internal load balancers must use ipv4.

    [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

    Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.

    [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

Returns:

See Also:



5300
5301
5302
5303
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5300

def set_ip_address_type(params = {}, options = {})
  req = build_request(:set_ip_address_type, params)
  req.send_request(options)
end

#set_rule_priorities(params = {}) ⇒ Types::SetRulePrioritiesOutput

Sets the priorities of the specified rules.

You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

Examples:

Example: To set the rule priority


# This example sets the priority of the specified rule.

resp = client.set_rule_priorities({
  rule_priorities: [
    {
      priority: 5, 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  rules: [
    {
      actions: [
        {
          target_group_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
          type: "forward", 
        }, 
      ], 
      conditions: [
        {
          field: "path-pattern", 
          values: [
            "/img/*", 
          ], 
        }, 
      ], 
      is_default: false, 
      priority: "5", 
      rule_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.set_rule_priorities({
  rule_priorities: [ # required
    {
      rule_arn: "RuleArn",
      priority: 1,
    },
  ],
})

Response structure


resp.rules #=> Array
resp.rules[0].rule_arn #=> String
resp.rules[0].priority #=> String
resp.rules[0].conditions #=> Array
resp.rules[0].conditions[0].field #=> String
resp.rules[0].conditions[0].values #=> Array
resp.rules[0].conditions[0].values[0] #=> String
resp.rules[0].conditions[0].host_header_config.values #=> Array
resp.rules[0].conditions[0].host_header_config.values[0] #=> String
resp.rules[0].conditions[0].host_header_config.regex_values #=> Array
resp.rules[0].conditions[0].host_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.values #=> Array
resp.rules[0].conditions[0].path_pattern_config.values[0] #=> String
resp.rules[0].conditions[0].path_pattern_config.regex_values #=> Array
resp.rules[0].conditions[0].path_pattern_config.regex_values[0] #=> String
resp.rules[0].conditions[0].http_header_config.http_header_name #=> String
resp.rules[0].conditions[0].http_header_config.values #=> Array
resp.rules[0].conditions[0].http_header_config.values[0] #=> String
resp.rules[0].conditions[0].http_header_config.regex_values #=> Array
resp.rules[0].conditions[0].http_header_config.regex_values[0] #=> String
resp.rules[0].conditions[0].query_string_config.values #=> Array
resp.rules[0].conditions[0].query_string_config.values[0].key #=> String
resp.rules[0].conditions[0].query_string_config.values[0].value #=> String
resp.rules[0].conditions[0].http_request_method_config.values #=> Array
resp.rules[0].conditions[0].http_request_method_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.values #=> Array
resp.rules[0].conditions[0].source_ip_config.values[0] #=> String
resp.rules[0].conditions[0].source_ip_config.ip_address_type #=> String, one of "ipv4", "ipv6"
resp.rules[0].conditions[0].regex_values #=> Array
resp.rules[0].conditions[0].regex_values[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].type #=> String, one of "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation"
resp.rules[0].actions[0].target_group_arn #=> String
resp.rules[0].actions[0].authenticate_oidc_config.issuer #=> String
resp.rules[0].actions[0].authenticate_oidc_config.authorization_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config.token_endpoint #=> String
resp.rules[0].actions[0].authenticate_oidc_config. #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_id #=> String
resp.rules[0].actions[0].authenticate_oidc_config.client_secret #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_oidc_config.scope #=> String
resp.rules[0].actions[0].authenticate_oidc_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_oidc_config.authentication_request_extra_params["AuthenticateOidcActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_oidc_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].authenticate_oidc_config.use_existing_client_secret #=> Boolean
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_arn #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_client_id #=> String
resp.rules[0].actions[0].authenticate_cognito_config.user_pool_domain #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_cookie_name #=> String
resp.rules[0].actions[0].authenticate_cognito_config.scope #=> String
resp.rules[0].actions[0].authenticate_cognito_config.session_timeout #=> Integer
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params #=> Hash
resp.rules[0].actions[0].authenticate_cognito_config.authentication_request_extra_params["AuthenticateCognitoActionAuthenticationRequestParamName"] #=> String
resp.rules[0].actions[0].authenticate_cognito_config.on_unauthenticated_request #=> String, one of "deny", "allow", "authenticate"
resp.rules[0].actions[0].order #=> Integer
resp.rules[0].actions[0].redirect_config.protocol #=> String
resp.rules[0].actions[0].redirect_config.port #=> String
resp.rules[0].actions[0].redirect_config.host #=> String
resp.rules[0].actions[0].redirect_config.path #=> String
resp.rules[0].actions[0].redirect_config.query #=> String
resp.rules[0].actions[0].redirect_config.status_code #=> String, one of "HTTP_301", "HTTP_302"
resp.rules[0].actions[0].fixed_response_config.message_body #=> String
resp.rules[0].actions[0].fixed_response_config.status_code #=> String
resp.rules[0].actions[0].fixed_response_config.content_type #=> String
resp.rules[0].actions[0].forward_config.target_groups #=> Array
resp.rules[0].actions[0].forward_config.target_groups[0].target_group_arn #=> String
resp.rules[0].actions[0].forward_config.target_groups[0].weight #=> Integer
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.enabled #=> Boolean
resp.rules[0].actions[0].forward_config.target_group_stickiness_config.duration_seconds #=> Integer
resp.rules[0].actions[0].jwt_validation_config.jwks_endpoint #=> String
resp.rules[0].actions[0].jwt_validation_config.issuer #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].format #=> String, one of "single-string", "string-array", "space-separated-values"
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].name #=> String
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values #=> Array
resp.rules[0].actions[0].jwt_validation_config.additional_claims[0].values[0] #=> String
resp.rules[0].is_default #=> Boolean
resp.rules[0].transforms #=> Array
resp.rules[0].transforms[0].type #=> String, one of "host-header-rewrite", "url-rewrite"
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].host_header_rewrite_config.rewrites[0].replace #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites #=> Array
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].regex #=> String
resp.rules[0].transforms[0].url_rewrite_config.rewrites[0].replace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



5461
5462
5463
5464
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5461

def set_rule_priorities(params = {}, options = {})
  req = build_request(:set_rule_priorities, params)
  req.send_request(options)
end

#set_security_groups(params = {}) ⇒ Types::SetSecurityGroupsOutput

Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.

You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.

You can't associate a security group with a Gateway Load Balancer.

Examples:

Example: To associate a security group with a load balancer


# This example associates the specified security group with the specified load balancer.

resp = client.set_security_groups({
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  security_groups: [
    "sg-5943793c", 
  ], 
})

resp.to_h outputs the following:
{
  security_group_ids: [
    "sg-5943793c", 
  ], 
}

Request syntax with placeholder values


resp = client.set_security_groups({
  load_balancer_arn: "LoadBalancerArn", # required
  security_groups: ["SecurityGroupId"], # required
  enforce_security_group_inbound_rules_on_private_link_traffic: "on", # accepts on, off
})

Response structure


resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.enforce_security_group_inbound_rules_on_private_link_traffic #=> String, one of "on", "off"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :security_groups (required, Array<String>) —

    The IDs of the security groups.

  • :enforce_security_group_inbound_rules_on_private_link_traffic (String) —

    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink. Applies only if the load balancer has an associated security group. The default is on.

Returns:

See Also:



5530
5531
5532
5533
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5530

def set_security_groups(params = {}, options = {})
  req = build_request(:set_security_groups, params)
  req.send_request(options)
end

#set_subnets(params = {}) ⇒ Types::SetSubnetsOutput

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.

Examples:

Example: To enable Availability Zones for a load balancer


# This example enables the Availability Zones for the specified subnets for the specified load balancer.

resp = client.set_subnets({
  load_balancer_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
  subnets: [
    "subnet-8360a9e7", 
    "subnet-b7d581c0", 
  ], 
})

resp.to_h outputs the following:
{
  availability_zones: [
    {
      subnet_id: "subnet-8360a9e7", 
      zone_name: "us-west-2a", 
    }, 
    {
      subnet_id: "subnet-b7d581c0", 
      zone_name: "us-west-2b", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.set_subnets({
  load_balancer_arn: "LoadBalancerArn", # required
  subnets: ["SubnetId"],
  subnet_mappings: [
    {
      subnet_id: "SubnetId",
      allocation_id: "AllocationId",
      private_i_pv_4_address: "PrivateIPv4Address",
      i_pv_6_address: "IPv6Address",
      source_nat_ipv_6_prefix: "SourceNatIpv6Prefix",
    },
  ],
  ip_address_type: "ipv4", # accepts ipv4, dualstack, dualstack-without-public-ipv4
  enable_prefix_for_ipv_6_source_nat: "on", # accepts on, off
})

Response structure


resp.availability_zones #=> Array
resp.availability_zones[0].zone_name #=> String
resp.availability_zones[0].subnet_id #=> String
resp.availability_zones[0].outpost_id #=> String
resp.availability_zones[0].load_balancer_addresses #=> Array
resp.availability_zones[0].load_balancer_addresses[0].ip_address #=> String
resp.availability_zones[0].load_balancer_addresses[0].allocation_id #=> String
resp.availability_zones[0].load_balancer_addresses[0].private_i_pv_4_address #=> String
resp.availability_zones[0].load_balancer_addresses[0].i_pv_6_address #=> String
resp.availability_zones[0].source_nat_ipv_6_prefixes #=> Array
resp.availability_zones[0].source_nat_ipv_6_prefixes[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack", "dualstack-without-public-ipv4"
resp.enable_prefix_for_ipv_6_source_nat #=> String, one of "on", "off"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :load_balancer_arn (required, String) —

    The Amazon Resource Name (ARN) of the load balancer.

  • :subnets (Array<String>) —

    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

    [Application Load Balancers] You must specify subnets from at least two Availability Zones.

    [Application Load Balancers on Outposts] You must specify one Outpost subnet.

    [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

    [Network Load Balancers] You can specify subnets from one or more Availability Zones.

    [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

  • :subnet_mappings (Array<Types::SubnetMapping>) —

    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

    [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.

    [Application Load Balancers on Outposts] You must specify one Outpost subnet.

    [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

    [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

    [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

  • :ip_address_type (String) —

    The IP address type.

    [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

    [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

  • :enable_prefix_for_ipv_6_source_nat (String) —

    [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.

Returns:

See Also:



5677
5678
5679
5680
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5677

def set_subnets(params = {}, options = {})
  req = build_request(:set_subnets, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
load_balancer_available #describe_load_balancers 15 40
load_balancer_exists #describe_load_balancers 15 40
load_balancers_deleted #describe_load_balancers 15 40
target_deregistered #describe_target_health 15 40
target_in_service #describe_target_health 15 40

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



5796
5797
5798
5799
5800
 
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5796

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end