lb

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.lb.AwaitableGetListenerResult(arn=None, certificate_arn=None, default_actions=None, load_balancer_arn=None, port=None, protocol=None, ssl_policy=None, id=None)
class pulumi_aws.lb.AwaitableGetLoadBalancerResult(access_logs=None, arn=None, arn_suffix=None, dns_name=None, enable_deletion_protection=None, idle_timeout=None, internal=None, load_balancer_type=None, name=None, security_groups=None, subnet_mappings=None, subnets=None, tags=None, vpc_id=None, zone_id=None, id=None)
class pulumi_aws.lb.AwaitableGetTargetGroupResult(arn=None, arn_suffix=None, deregistration_delay=None, health_check=None, lambda_multi_value_headers_enabled=None, name=None, port=None, protocol=None, proxy_protocol_v2=None, slow_start=None, stickiness=None, tags=None, target_type=None, vpc_id=None, id=None)
class pulumi_aws.lb.GetListenerResult(arn=None, certificate_arn=None, default_actions=None, load_balancer_arn=None, port=None, protocol=None, ssl_policy=None, id=None)

A collection of values returned by getListener.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.lb.GetLoadBalancerResult(access_logs=None, arn=None, arn_suffix=None, dns_name=None, enable_deletion_protection=None, idle_timeout=None, internal=None, load_balancer_type=None, name=None, security_groups=None, subnet_mappings=None, subnets=None, tags=None, vpc_id=None, zone_id=None, id=None)

A collection of values returned by getLoadBalancer.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.lb.GetTargetGroupResult(arn=None, arn_suffix=None, deregistration_delay=None, health_check=None, lambda_multi_value_headers_enabled=None, name=None, port=None, protocol=None, proxy_protocol_v2=None, slow_start=None, stickiness=None, tags=None, target_type=None, vpc_id=None, id=None)

A collection of values returned by getTargetGroup.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.lb.Listener(resource_name, opts=None, certificate_arn=None, default_actions=None, load_balancer_arn=None, port=None, protocol=None, ssl_policy=None, __props__=None, __name__=None, __opts__=None)

Provides a Load Balancer Listener resource.

Note: alb.Listener is known as lb.Listener. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificate_arn (pulumi.Input[str]) – The ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the ``lb.ListenerCertificate` resource <https://www.terraform.io/docs/providers/aws/r/lb_listener_certificate.html>`_.

  • default_actions (pulumi.Input[list]) – An Action block. Action blocks are documented below.

  • load_balancer_arn (pulumi.Input[str]) – The ARN of the load balancer.

  • port (pulumi.Input[float]) – The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

  • protocol (pulumi.Input[str]) – The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

  • ssl_policy (pulumi.Input[str]) – The name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS.

The default_actions object supports the following:

  • authenticateCognito (pulumi.Input[dict])

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (pulumi.Input[str]) - The ARN of the Cognito user pool.

    • userPoolClientId (pulumi.Input[str]) - The ID of the Cognito user pool client.

    • userPoolDomain (pulumi.Input[str]) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (pulumi.Input[dict])

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (pulumi.Input[str]) - The authorization endpoint of the IdP.

    • clientId (pulumi.Input[str]) - The OAuth 2.0 client identifier.

    • client_secret (pulumi.Input[str]) - The OAuth 2.0 client secret.

    • issuer (pulumi.Input[str]) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (pulumi.Input[str]) - The token endpoint of the IdP.

    • userInfoEndpoint (pulumi.Input[str]) - The user info endpoint of the IdP.

  • fixedResponse (pulumi.Input[dict]) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (pulumi.Input[str]) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (pulumi.Input[str]) - The message body.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (pulumi.Input[float])

  • redirect (pulumi.Input[dict]) - Information for creating a redirect action. Required if type is redirect.

    • host (pulumi.Input[str]) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (pulumi.Input[str]) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (pulumi.Input[str]) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (pulumi.Input[str]) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (pulumi.Input[str]) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (pulumi.Input[str]) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (pulumi.Input[str]) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

arn = None

The ARN of the listener (matches id)

certificate_arn = None

The ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the ``lb.ListenerCertificate` resource <https://www.terraform.io/docs/providers/aws/r/lb_listener_certificate.html>`_.

default_actions = None

An Action block. Action blocks are documented below.

  • authenticateCognito (dict)

    • authenticationRequestExtraParams (dict) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (str) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (str) - The set of user claims to be requested from the IdP.

    • sessionCookieName (str) - The name of the cookie used to maintain session information.

    • sessionTimeout (float) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (str) - The ARN of the Cognito user pool.

    • userPoolClientId (str) - The ID of the Cognito user pool client.

    • userPoolDomain (str) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (dict)

    • authenticationRequestExtraParams (dict) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (str) - The authorization endpoint of the IdP.

    • clientId (str) - The OAuth 2.0 client identifier.

    • client_secret (str) - The OAuth 2.0 client secret.

    • issuer (str) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (str) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (str) - The set of user claims to be requested from the IdP.

    • sessionCookieName (str) - The name of the cookie used to maintain session information.

    • sessionTimeout (float) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (str) - The token endpoint of the IdP.

    • userInfoEndpoint (str) - The user info endpoint of the IdP.

  • fixedResponse (dict) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (str) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (str) - The message body.

    • status_code (str) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (float)

  • redirect (dict) - Information for creating a redirect action. Required if type is redirect.

    • host (str) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (str) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (str) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (str) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (str) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (str) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (str) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (str) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

load_balancer_arn = None

The ARN of the load balancer.

port = None

The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

protocol = None

The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

ssl_policy = None

The name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS.

static get(resource_name, id, opts=None, arn=None, certificate_arn=None, default_actions=None, load_balancer_arn=None, port=None, protocol=None, ssl_policy=None)

Get an existing Listener resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the listener (matches id)

  • certificate_arn (pulumi.Input[str]) – The ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the ``lb.ListenerCertificate` resource <https://www.terraform.io/docs/providers/aws/r/lb_listener_certificate.html>`_.

  • default_actions (pulumi.Input[list]) – An Action block. Action blocks are documented below.

  • load_balancer_arn (pulumi.Input[str]) – The ARN of the load balancer.

  • port (pulumi.Input[float]) – The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

  • protocol (pulumi.Input[str]) – The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

  • ssl_policy (pulumi.Input[str]) – The name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS.

The default_actions object supports the following:

  • authenticateCognito (pulumi.Input[dict])

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (pulumi.Input[str]) - The ARN of the Cognito user pool.

    • userPoolClientId (pulumi.Input[str]) - The ID of the Cognito user pool client.

    • userPoolDomain (pulumi.Input[str]) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (pulumi.Input[dict])

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (pulumi.Input[str]) - The authorization endpoint of the IdP.

    • clientId (pulumi.Input[str]) - The OAuth 2.0 client identifier.

    • client_secret (pulumi.Input[str]) - The OAuth 2.0 client secret.

    • issuer (pulumi.Input[str]) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (pulumi.Input[str]) - The token endpoint of the IdP.

    • userInfoEndpoint (pulumi.Input[str]) - The user info endpoint of the IdP.

  • fixedResponse (pulumi.Input[dict]) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (pulumi.Input[str]) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (pulumi.Input[str]) - The message body.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (pulumi.Input[float])

  • redirect (pulumi.Input[dict]) - Information for creating a redirect action. Required if type is redirect.

    • host (pulumi.Input[str]) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (pulumi.Input[str]) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (pulumi.Input[str]) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (pulumi.Input[str]) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (pulumi.Input[str]) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (pulumi.Input[str]) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (pulumi.Input[str]) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.lb.ListenerCertificate(resource_name, opts=None, certificate_arn=None, listener_arn=None, __props__=None, __name__=None, __opts__=None)

Provides a Load Balancer Listener Certificate resource.

This resource is for additional certificates and does not replace the default certificate on the listener.

Note: alb.ListenerCertificate is known as lb.ListenerCertificate. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificate_arn (pulumi.Input[str]) – The ARN of the certificate to attach to the listener.

  • listener_arn (pulumi.Input[str]) – The ARN of the listener to which to attach the certificate.

certificate_arn = None

The ARN of the certificate to attach to the listener.

listener_arn = None

The ARN of the listener to which to attach the certificate.

static get(resource_name, id, opts=None, certificate_arn=None, listener_arn=None)

Get an existing ListenerCertificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificate_arn (pulumi.Input[str]) – The ARN of the certificate to attach to the listener.

  • listener_arn (pulumi.Input[str]) – The ARN of the listener to which to attach the certificate.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.lb.ListenerRule(resource_name, opts=None, actions=None, conditions=None, listener_arn=None, priority=None, __props__=None, __name__=None, __opts__=None)

Provides a Load Balancer Listener Rule resource.

Note: alb.ListenerRule is known as lb.ListenerRule. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – An Action block. Action blocks are documented below.

  • conditions (pulumi.Input[list]) – A Condition block. Condition blocks are documented below.

  • listener_arn (pulumi.Input[str]) – The ARN of the listener to which to attach the rule.

  • priority (pulumi.Input[float]) – The priority for the rule between 1 and 50000. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can’t have multiple rules with the same priority.

The actions object supports the following:

  • authenticateCognito (pulumi.Input[dict]) - Information for creating an authenticate action using Cognito. Required if type is authenticate-cognito.

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (pulumi.Input[str]) - The ARN of the Cognito user pool.

    • userPoolClientId (pulumi.Input[str]) - The ID of the Cognito user pool client.

    • userPoolDomain (pulumi.Input[str]) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (pulumi.Input[dict]) - Information for creating an authenticate action using OIDC. Required if type is authenticate-oidc.

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (pulumi.Input[str]) - The authorization endpoint of the IdP.

    • clientId (pulumi.Input[str]) - The OAuth 2.0 client identifier.

    • client_secret (pulumi.Input[str]) - The OAuth 2.0 client secret.

    • issuer (pulumi.Input[str]) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (pulumi.Input[str]) - The token endpoint of the IdP.

    • userInfoEndpoint (pulumi.Input[str]) - The user info endpoint of the IdP.

  • fixedResponse (pulumi.Input[dict]) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (pulumi.Input[str]) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (pulumi.Input[str]) - The message body.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (pulumi.Input[float])

  • redirect (pulumi.Input[dict]) - Information for creating a redirect action. Required if type is redirect.

    • host (pulumi.Input[str]) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (pulumi.Input[str]) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (pulumi.Input[str]) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (pulumi.Input[str]) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (pulumi.Input[str]) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (pulumi.Input[str]) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (pulumi.Input[str]) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

The conditions object supports the following:

  • field (pulumi.Input[str]) - The name of the field. Must be one of path-pattern for path based routing or host-header for host based routing.

  • values (pulumi.Input[str]) - The path patterns to match. A maximum of 1 can be defined.

actions = None

An Action block. Action blocks are documented below.

  • authenticateCognito (dict) - Information for creating an authenticate action using Cognito. Required if type is authenticate-cognito.

    • authenticationRequestExtraParams (dict) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (str) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (str) - The set of user claims to be requested from the IdP.

    • sessionCookieName (str) - The name of the cookie used to maintain session information.

    • sessionTimeout (float) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (str) - The ARN of the Cognito user pool.

    • userPoolClientId (str) - The ID of the Cognito user pool client.

    • userPoolDomain (str) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (dict) - Information for creating an authenticate action using OIDC. Required if type is authenticate-oidc.

    • authenticationRequestExtraParams (dict) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (str) - The authorization endpoint of the IdP.

    • clientId (str) - The OAuth 2.0 client identifier.

    • client_secret (str) - The OAuth 2.0 client secret.

    • issuer (str) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (str) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (str) - The set of user claims to be requested from the IdP.

    • sessionCookieName (str) - The name of the cookie used to maintain session information.

    • sessionTimeout (float) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (str) - The token endpoint of the IdP.

    • userInfoEndpoint (str) - The user info endpoint of the IdP.

  • fixedResponse (dict) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (str) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (str) - The message body.

    • status_code (str) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (float)

  • redirect (dict) - Information for creating a redirect action. Required if type is redirect.

    • host (str) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (str) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (str) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (str) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (str) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (str) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (str) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (str) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

arn = None

The ARN of the rule (matches id)

conditions = None

A Condition block. Condition blocks are documented below.

  • field (str) - The name of the field. Must be one of path-pattern for path based routing or host-header for host based routing.

  • values (str) - The path patterns to match. A maximum of 1 can be defined.

listener_arn = None

The ARN of the listener to which to attach the rule.

priority = None

The priority for the rule between 1 and 50000. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can’t have multiple rules with the same priority.

static get(resource_name, id, opts=None, actions=None, arn=None, conditions=None, listener_arn=None, priority=None)

Get an existing ListenerRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – An Action block. Action blocks are documented below.

  • arn (pulumi.Input[str]) – The ARN of the rule (matches id)

  • conditions (pulumi.Input[list]) – A Condition block. Condition blocks are documented below.

  • listener_arn (pulumi.Input[str]) – The ARN of the listener to which to attach the rule.

  • priority (pulumi.Input[float]) – The priority for the rule between 1 and 50000. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can’t have multiple rules with the same priority.

The actions object supports the following:

  • authenticateCognito (pulumi.Input[dict]) - Information for creating an authenticate action using Cognito. Required if type is authenticate-cognito.

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • userPoolArn (pulumi.Input[str]) - The ARN of the Cognito user pool.

    • userPoolClientId (pulumi.Input[str]) - The ID of the Cognito user pool client.

    • userPoolDomain (pulumi.Input[str]) - The domain prefix or fully-qualified domain name of the Cognito user pool.

  • authenticateOidc (pulumi.Input[dict]) - Information for creating an authenticate action using OIDC. Required if type is authenticate-oidc.

    • authenticationRequestExtraParams (pulumi.Input[dict]) - The query parameters to include in the redirect request to the authorization endpoint. Max: 10.

    • authorizationEndpoint (pulumi.Input[str]) - The authorization endpoint of the IdP.

    • clientId (pulumi.Input[str]) - The OAuth 2.0 client identifier.

    • client_secret (pulumi.Input[str]) - The OAuth 2.0 client secret.

    • issuer (pulumi.Input[str]) - The OIDC issuer identifier of the IdP.

    • onUnauthenticatedRequest (pulumi.Input[str]) - The behavior if the user is not authenticated. Valid values: deny, allow and authenticate

    • scope (pulumi.Input[str]) - The set of user claims to be requested from the IdP.

    • sessionCookieName (pulumi.Input[str]) - The name of the cookie used to maintain session information.

    • sessionTimeout (pulumi.Input[float]) - The maximum duration of the authentication session, in seconds.

    • tokenEndpoint (pulumi.Input[str]) - The token endpoint of the IdP.

    • userInfoEndpoint (pulumi.Input[str]) - The user info endpoint of the IdP.

  • fixedResponse (pulumi.Input[dict]) - Information for creating an action that returns a custom HTTP response. Required if type is fixed-response.

    • content_type (pulumi.Input[str]) - The content type. Valid values are text/plain, text/css, text/html, application/javascript and application/json.

    • messageBody (pulumi.Input[str]) - The message body.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • order (pulumi.Input[float])

  • redirect (pulumi.Input[dict]) - Information for creating a redirect action. Required if type is redirect.

    • host (pulumi.Input[str]) - The hostname. This component is not percent-encoded. The hostname can contain #{host}. Defaults to #{host}.

    • path (pulumi.Input[str]) - The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to /#{path}.

    • port (pulumi.Input[str]) - The port. Specify a value from 1 to 65535 or #{port}. Defaults to #{port}.

    • protocol (pulumi.Input[str]) - The protocol. Valid values are HTTP, HTTPS, or #{protocol}. Defaults to #{protocol}.

    • query (pulumi.Input[str]) - The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading “?”. Defaults to #{query}.

    • status_code (pulumi.Input[str]) - The HTTP response code. Valid values are 2XX, 4XX, or 5XX.

  • target_group_arn (pulumi.Input[str]) - The ARN of the Target Group to which to route traffic. Required if type is forward.

  • type (pulumi.Input[str]) - The type of routing action. Valid values are forward, redirect, fixed-response, authenticate-cognito and authenticate-oidc.

The conditions object supports the following:

  • field (pulumi.Input[str]) - The name of the field. Must be one of path-pattern for path based routing or host-header for host based routing.

  • values (pulumi.Input[str]) - The path patterns to match. A maximum of 1 can be defined.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.lb.LoadBalancer(resource_name, opts=None, access_logs=None, enable_cross_zone_load_balancing=None, enable_deletion_protection=None, enable_http2=None, idle_timeout=None, internal=None, ip_address_type=None, load_balancer_type=None, name=None, name_prefix=None, security_groups=None, subnet_mappings=None, subnets=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a Load Balancer resource.

Note: alb.LoadBalancer is known as lb.LoadBalancer. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_logs (pulumi.Input[dict]) – An Access Logs block. Access Logs documented below.

  • enable_cross_zone_load_balancing (pulumi.Input[bool]) – If true, cross-zone load balancing of the load balancer will be enabled. This is a network load balancer feature. Defaults to false.

  • enable_deletion_protection (pulumi.Input[bool]) – If true, deletion of the load balancer will be disabled via the AWS API. This will prevent this provider from deleting the load balancer. Defaults to false.

  • enable_http2 (pulumi.Input[bool]) – Indicates whether HTTP/2 is enabled in application load balancers. Defaults to true.

  • idle_timeout (pulumi.Input[float]) – The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type application. Default: 60.

  • internal (pulumi.Input[bool]) – If true, the LB will be internal.

  • ip_address_type (pulumi.Input[str]) – The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack

  • load_balancer_type (pulumi.Input[str]) – The type of load balancer to create. Possible values are application or network. The default value is application.

  • name (pulumi.Input[str]) – The name of the LB. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. If not specified, this provider will autogenerate a name beginning with tf-lb.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • security_groups (pulumi.Input[list]) – A list of security group IDs to assign to the LB. Only valid for Load Balancers of type application.

  • subnet_mappings (pulumi.Input[list]) – A subnet mapping block as documented below.

  • subnets (pulumi.Input[list]) – A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type network. Changing this value for load balancers of type network will force a recreation of the resource.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The access_logs object supports the following:

  • bucket (pulumi.Input[str]) - The S3 bucket name to store the logs in.

  • enabled (pulumi.Input[bool]) - Boolean to enable / disable access_logs. Defaults to false, even when bucket is specified.

  • prefix (pulumi.Input[str]) - The S3 bucket prefix. Logs are stored in the root if not configured.

The subnet_mappings object supports the following:

  • allocation_id (pulumi.Input[str]) - The allocation ID of the Elastic IP address.

  • subnet_id (pulumi.Input[str]) - The id of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.

access_logs = None

An Access Logs block. Access Logs documented below.

  • bucket (str) - The S3 bucket name to store the logs in.

  • enabled (bool) - Boolean to enable / disable access_logs. Defaults to false, even when bucket is specified.

  • prefix (str) - The S3 bucket prefix. Logs are stored in the root if not configured.

arn = None

The ARN of the load balancer (matches id).

arn_suffix = None

The ARN suffix for use with CloudWatch Metrics.

dns_name = None

The DNS name of the load balancer.

enable_cross_zone_load_balancing = None

If true, cross-zone load balancing of the load balancer will be enabled. This is a network load balancer feature. Defaults to false.

enable_deletion_protection = None

If true, deletion of the load balancer will be disabled via the AWS API. This will prevent this provider from deleting the load balancer. Defaults to false.

enable_http2 = None

Indicates whether HTTP/2 is enabled in application load balancers. Defaults to true.

idle_timeout = None

The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type application. Default: 60.

internal = None

If true, the LB will be internal.

ip_address_type = None

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack

load_balancer_type = None

The type of load balancer to create. Possible values are application or network. The default value is application.

name = None

The name of the LB. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. If not specified, this provider will autogenerate a name beginning with tf-lb.

name_prefix = None

Creates a unique name beginning with the specified prefix. Conflicts with name.

security_groups = None

A list of security group IDs to assign to the LB. Only valid for Load Balancers of type application.

subnet_mappings = None

A subnet mapping block as documented below.

  • allocation_id (str) - The allocation ID of the Elastic IP address.

  • subnet_id (str) - The id of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.

subnets = None

A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type network. Changing this value for load balancers of type network will force a recreation of the resource.

tags = None

A mapping of tags to assign to the resource.

zone_id = None

The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).

static get(resource_name, id, opts=None, access_logs=None, arn=None, arn_suffix=None, dns_name=None, enable_cross_zone_load_balancing=None, enable_deletion_protection=None, enable_http2=None, idle_timeout=None, internal=None, ip_address_type=None, load_balancer_type=None, name=None, name_prefix=None, security_groups=None, subnet_mappings=None, subnets=None, tags=None, vpc_id=None, zone_id=None)

Get an existing LoadBalancer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_logs (pulumi.Input[dict]) – An Access Logs block. Access Logs documented below.

  • arn (pulumi.Input[str]) – The ARN of the load balancer (matches id).

  • arn_suffix (pulumi.Input[str]) – The ARN suffix for use with CloudWatch Metrics.

  • dns_name (pulumi.Input[str]) – The DNS name of the load balancer.

  • enable_cross_zone_load_balancing (pulumi.Input[bool]) – If true, cross-zone load balancing of the load balancer will be enabled. This is a network load balancer feature. Defaults to false.

  • enable_deletion_protection (pulumi.Input[bool]) – If true, deletion of the load balancer will be disabled via the AWS API. This will prevent this provider from deleting the load balancer. Defaults to false.

  • enable_http2 (pulumi.Input[bool]) – Indicates whether HTTP/2 is enabled in application load balancers. Defaults to true.

  • idle_timeout (pulumi.Input[float]) – The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type application. Default: 60.

  • internal (pulumi.Input[bool]) – If true, the LB will be internal.

  • ip_address_type (pulumi.Input[str]) – The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack

  • load_balancer_type (pulumi.Input[str]) – The type of load balancer to create. Possible values are application or network. The default value is application.

  • name (pulumi.Input[str]) – The name of the LB. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. If not specified, this provider will autogenerate a name beginning with tf-lb.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • security_groups (pulumi.Input[list]) – A list of security group IDs to assign to the LB. Only valid for Load Balancers of type application.

  • subnet_mappings (pulumi.Input[list]) – A subnet mapping block as documented below.

  • subnets (pulumi.Input[list]) – A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type network. Changing this value for load balancers of type network will force a recreation of the resource.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • zone_id (pulumi.Input[str]) – The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).

The access_logs object supports the following:

  • bucket (pulumi.Input[str]) - The S3 bucket name to store the logs in.

  • enabled (pulumi.Input[bool]) - Boolean to enable / disable access_logs. Defaults to false, even when bucket is specified.

  • prefix (pulumi.Input[str]) - The S3 bucket prefix. Logs are stored in the root if not configured.

The subnet_mappings object supports the following:

  • allocation_id (pulumi.Input[str]) - The allocation ID of the Elastic IP address.

  • subnet_id (pulumi.Input[str]) - The id of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.lb.TargetGroup(resource_name, opts=None, deregistration_delay=None, health_check=None, lambda_multi_value_headers_enabled=None, name=None, name_prefix=None, port=None, protocol=None, proxy_protocol_v2=None, slow_start=None, stickiness=None, tags=None, target_type=None, vpc_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Target Group resource for use with Load Balancer resources.

Note: alb.TargetGroup is known as lb.TargetGroup. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • deregistration_delay (pulumi.Input[float]) – The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.

  • health_check (pulumi.Input[dict]) – A Health Check block. Health Check blocks are documented below.

  • lambda_multi_value_headers_enabled (pulumi.Input[bool]) – Boolean whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when target_type is lambda.

  • name (pulumi.Input[str]) – The name of the target group. If omitted, this provider will assign a random, unique name.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.

  • port (pulumi.Input[float]) – The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

  • protocol (pulumi.Input[str]) – The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

  • proxy_protocol_v2 (pulumi.Input[bool]) – Boolean to enable / disable support for proxy protocol v2 on Network Load Balancers. See doc for more information.

  • slow_start (pulumi.Input[float]) – The amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.

  • stickiness (pulumi.Input[dict]) – A Stickiness block. Stickiness blocks are documented below. stickiness is only valid if used with Load Balancers of type Application

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_type (pulumi.Input[str]) – The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address) or lambda (targets are specified by lambda arn). The default is instance. Note that you can’t specify targets for a target group using both instance IDs and IP addresses. If the target type is ip, 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.

  • vpc_id (pulumi.Input[str]) – The identifier of the VPC in which to create the target group. Required when target_type is instance or ip. Does not apply when target_type is lambda.

The health_check object supports the following:

  • enabled (pulumi.Input[bool]) - Indicates whether health checks are enabled. Defaults to true.

  • healthyThreshold (pulumi.Input[float]) - The number of consecutive health checks successes required before considering an unhealthy target healthy. Defaults to 3.

  • interval (pulumi.Input[float]) - The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. For lambda target groups, it needs to be greater as the timeout of the underlying lambda. Default 30 seconds.

  • matcher (pulumi.Input[str])

  • path (pulumi.Input[str]) - The destination for the health check request. Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

  • port (pulumi.Input[str]) - The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

  • protocol (pulumi.Input[str]) - The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

  • timeout (pulumi.Input[float]) - The amount of time, in seconds, during which no response means a failed health check. For Application Load Balancers, the range is 2 to 120 seconds, and the default is 5 seconds for the instance target type and 30 seconds for the lambda target type. For Network Load Balancers, you cannot set a custom value, and the default is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

  • unhealthyThreshold (pulumi.Input[float]) - The number of consecutive health check failures required before considering the target unhealthy . For Network Load Balancers, this value must be the same as the healthy_threshold. Defaults to 3.

    • matcher (Required for HTTP/HTTPS ALB) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”). Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

The stickiness object supports the following:

  • cookieDuration (pulumi.Input[float]) - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

  • enabled (pulumi.Input[bool]) - Indicates whether health checks are enabled. Defaults to true.

  • type (pulumi.Input[str]) - The type of sticky sessions. The only current possible value is lb_cookie.

arn = None

The ARN of the Target Group (matches id)

arn_suffix = None

The ARN suffix for use with CloudWatch Metrics.

deregistration_delay = None

The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.

health_check = None

A Health Check block. Health Check blocks are documented below.

  • enabled (bool) - Indicates whether health checks are enabled. Defaults to true.

  • healthyThreshold (float) - The number of consecutive health checks successes required before considering an unhealthy target healthy. Defaults to 3.

  • interval (float) - The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. For lambda target groups, it needs to be greater as the timeout of the underlying lambda. Default 30 seconds.

  • matcher (str)

  • path (str) - The destination for the health check request. Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

  • port (str) - The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

  • protocol (str) - The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

  • timeout (float) - The amount of time, in seconds, during which no response means a failed health check. For Application Load Balancers, the range is 2 to 120 seconds, and the default is 5 seconds for the instance target type and 30 seconds for the lambda target type. For Network Load Balancers, you cannot set a custom value, and the default is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

  • unhealthyThreshold (float) - The number of consecutive health check failures required before considering the target unhealthy . For Network Load Balancers, this value must be the same as the healthy_threshold. Defaults to 3.

    • matcher (Required for HTTP/HTTPS ALB) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”). Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

lambda_multi_value_headers_enabled = None

Boolean whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when target_type is lambda.

name = None

The name of the target group. If omitted, this provider will assign a random, unique name.

name_prefix = None

Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.

port = None

The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

protocol = None

The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

proxy_protocol_v2 = None

Boolean to enable / disable support for proxy protocol v2 on Network Load Balancers. See doc for more information.

slow_start = None

The amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.

stickiness = None

A Stickiness block. Stickiness blocks are documented below. stickiness is only valid if used with Load Balancers of type Application

  • cookieDuration (float) - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

  • enabled (bool) - Indicates whether health checks are enabled. Defaults to true.

  • type (str) - The type of sticky sessions. The only current possible value is lb_cookie.

tags = None

A mapping of tags to assign to the resource.

target_type = None

The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address) or lambda (targets are specified by lambda arn). The default is instance. Note that you can’t specify targets for a target group using both instance IDs and IP addresses. If the target type is ip, 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.

vpc_id = None

The identifier of the VPC in which to create the target group. Required when target_type is instance or ip. Does not apply when target_type is lambda.

static get(resource_name, id, opts=None, arn=None, arn_suffix=None, deregistration_delay=None, health_check=None, lambda_multi_value_headers_enabled=None, name=None, name_prefix=None, port=None, protocol=None, proxy_protocol_v2=None, slow_start=None, stickiness=None, tags=None, target_type=None, vpc_id=None)

Get an existing TargetGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the Target Group (matches id)

  • arn_suffix (pulumi.Input[str]) – The ARN suffix for use with CloudWatch Metrics.

  • deregistration_delay (pulumi.Input[float]) – The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.

  • health_check (pulumi.Input[dict]) – A Health Check block. Health Check blocks are documented below.

  • lambda_multi_value_headers_enabled (pulumi.Input[bool]) – Boolean whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when target_type is lambda.

  • name (pulumi.Input[str]) – The name of the target group. If omitted, this provider will assign a random, unique name.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.

  • port (pulumi.Input[float]) – The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

  • protocol (pulumi.Input[str]) – The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

  • proxy_protocol_v2 (pulumi.Input[bool]) –

    Boolean to enable / disable support for proxy protocol v2 on Network Load Balancers. See doc for more information.

  • slow_start (pulumi.Input[float]) – The amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.

  • stickiness (pulumi.Input[dict]) – A Stickiness block. Stickiness blocks are documented below. stickiness is only valid if used with Load Balancers of type Application

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_type (pulumi.Input[str]) – The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address) or lambda (targets are specified by lambda arn). The default is instance. Note that you can’t specify targets for a target group using both instance IDs and IP addresses. If the target type is ip, 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.

  • vpc_id (pulumi.Input[str]) – The identifier of the VPC in which to create the target group. Required when target_type is instance or ip. Does not apply when target_type is lambda.

The health_check object supports the following:

  • enabled (pulumi.Input[bool]) - Indicates whether health checks are enabled. Defaults to true.

  • healthyThreshold (pulumi.Input[float]) - The number of consecutive health checks successes required before considering an unhealthy target healthy. Defaults to 3.

  • interval (pulumi.Input[float]) - The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. For lambda target groups, it needs to be greater as the timeout of the underlying lambda. Default 30 seconds.

  • matcher (pulumi.Input[str])

  • path (pulumi.Input[str]) - The destination for the health check request. Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

  • port (pulumi.Input[str]) - The port to use to connect with the target. Valid values are either ports 1-65536, or traffic-port. Defaults to traffic-port.

  • protocol (pulumi.Input[str]) - The protocol to use to connect with the target. Defaults to HTTP. Not applicable when target_type is lambda.

  • timeout (pulumi.Input[float]) - The amount of time, in seconds, during which no response means a failed health check. For Application Load Balancers, the range is 2 to 120 seconds, and the default is 5 seconds for the instance target type and 30 seconds for the lambda target type. For Network Load Balancers, you cannot set a custom value, and the default is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

  • unhealthyThreshold (pulumi.Input[float]) - The number of consecutive health check failures required before considering the target unhealthy . For Network Load Balancers, this value must be the same as the healthy_threshold. Defaults to 3.

    • matcher (Required for HTTP/HTTPS ALB) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”). Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP).

The stickiness object supports the following:

  • cookieDuration (pulumi.Input[float]) - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

  • enabled (pulumi.Input[bool]) - Indicates whether health checks are enabled. Defaults to true.

  • type (pulumi.Input[str]) - The type of sticky sessions. The only current possible value is lb_cookie.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.lb.TargetGroupAttachment(resource_name, opts=None, availability_zone=None, port=None, target_group_arn=None, target_id=None, __props__=None, __name__=None, __opts__=None)

Provides the ability to register instances and containers with an Application Load Balancer (ALB) or Network Load Balancer (NLB) target group. For attaching resources with Elastic Load Balancer (ELB), see the ``elb.Attachment` resource <https://www.terraform.io/docs/providers/aws/r/elb_attachment.html>`_.

Note: alb.TargetGroupAttachment is known as lb.TargetGroupAttachment. The functionality is identical.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • availability_zone (pulumi.Input[str]) – The Availability Zone where the IP address of the target is to be registered.

  • port (pulumi.Input[float]) – The port on which targets receive traffic.

  • target_group_arn (pulumi.Input[str]) – The ARN of the target group with which to register targets

  • target_id (pulumi.Input[str]) – The ID of the target. This is the Instance ID for an instance, or the container ID for an ECS container. If the target type is ip, specify an IP address. If the target type is lambda, specify the arn of lambda.

availability_zone = None

The Availability Zone where the IP address of the target is to be registered.

port = None

The port on which targets receive traffic.

target_group_arn = None

The ARN of the target group with which to register targets

target_id = None

The ID of the target. This is the Instance ID for an instance, or the container ID for an ECS container. If the target type is ip, specify an IP address. If the target type is lambda, specify the arn of lambda.

static get(resource_name, id, opts=None, availability_zone=None, port=None, target_group_arn=None, target_id=None)

Get an existing TargetGroupAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • availability_zone (pulumi.Input[str]) – The Availability Zone where the IP address of the target is to be registered.

  • port (pulumi.Input[float]) – The port on which targets receive traffic.

  • target_group_arn (pulumi.Input[str]) – The ARN of the target group with which to register targets

  • target_id (pulumi.Input[str]) – The ID of the target. This is the Instance ID for an instance, or the container ID for an ECS container. If the target type is ip, specify an IP address. If the target type is lambda, specify the arn of lambda.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_aws.lb.get_listener(arn=None, load_balancer_arn=None, port=None, opts=None)

Note: alb.Listener is known as lb.Listener. The functionality is identical.

Provides information about a Load Balancer Listener.

This data source can prove useful when a module accepts an LB Listener as an input variable and needs to know the LB it is attached to, or other information specific to the listener in question.

Parameters
  • arn (str) – The arn of the listener. Required if load_balancer_arn and port is not set.

  • load_balancer_arn (str) – The arn of the load balancer. Required if arn is not set.

  • port (float) – The port of the listener. Required if arn is not set.

pulumi_aws.lb.get_load_balancer(arn=None, name=None, tags=None, opts=None)

Note: alb.LoadBalancer is known as lb.LoadBalancer. The functionality is identical.

Provides information about a Load Balancer.

This data source can prove useful when a module accepts an LB as an input variable and needs to, for example, determine the security groups associated with it, etc.

Parameters
  • arn (str) – The full ARN of the load balancer.

  • name (str) – The unique name of the load balancer.

pulumi_aws.lb.get_target_group(arn=None, name=None, tags=None, opts=None)

Note: alb.TargetGroup is known as lb.TargetGroup. The functionality is identical.

Provides information about a Load Balancer Target Group.

This data source can prove useful when a module accepts an LB Target Group as an input variable and needs to know its attributes. It can also be used to get the ARN of an LB Target Group for use in other resources, given LB Target Group name.

Parameters
  • arn (str) – The full ARN of the target group.

  • name (str) – The unique name of the target group.