applicationloadbalancing

class pulumi_aws.applicationloadbalancing.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.applicationloadbalancing.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.applicationloadbalancing.GetTargetGroupResult(arn=None, arn_suffix=None, deregistration_delay=None, health_check=None, name=None, port=None, protocol=None, slow_start=None, stickiness=None, tags=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.applicationloadbalancing.Listener(resource_name, opts=None, certificate_arn=None, default_action=None, load_balancer_arn=None, port=None, protocol=None, ssl_policy=None, __name__=None, __opts__=None)

Provides a Load Balancer Listener resource.

Note: aws_alb_listener is known as aws_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 ``aws_lb_listener_certificate` resource <https://www.terraform.io/docs/providers/aws/r/lb_listener_certificate.html>`_.
  • default_action (pulumi.Input[dict]) – An Action block. Action blocks are documented below.
  • load_balancer_arn (pulumi.Input[str]) – The ARN of the load balancer.
  • port (pulumi.Input[int]) – 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.
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 ``aws_lb_listener_certificate` resource <https://www.terraform.io/docs/providers/aws/r/lb_listener_certificate.html>`_.

default_action = None

An Action block. Action blocks are documented below.

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.

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.applicationloadbalancing.ListenerCertificate(resource_name, opts=None, certificate_arn=None, listener_arn=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: aws_alb_listener_certificate is known as aws_lb_listener_certificate. 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.

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.applicationloadbalancing.ListenerRule(resource_name, opts=None, actions=None, conditions=None, listener_arn=None, priority=None, __name__=None, __opts__=None)

Provides a Load Balancer Listener Rule resource.

Note: aws_alb_listener_rule is known as aws_lb_listener_rule. 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[int]) – 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.
actions = None

An Action block. Action blocks are documented below.

arn = None

The ARN of the rule (matches id)

conditions = None

A Condition block. Condition blocks are documented below.

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.

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.applicationloadbalancing.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, __name__=None, __opts__=None)

Provides a Load Balancer resource.

Note: aws_alb is known as aws_lb. 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. Only valid for Load Balancers of type application.
  • 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 Terraform 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[int]) – 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, Terraform 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.
access_logs = None

An Access Logs block. Access Logs documented below. Only valid for Load Balancers of type application.

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 Terraform 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, Terraform 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.

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).

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.applicationloadbalancing.TargetGroup(resource_name, opts=None, deregistration_delay=None, health_check=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, __name__=None, __opts__=None)

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

Note: aws_alb_target_group is known as aws_lb_target_group. The functionality is identical.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • deregistration_delay (pulumi.Input[int]) – 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.
  • name (pulumi.Input[str]) – The name of the target group. If omitted, Terraform 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[int]) – 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[int]) – 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.
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.

name = None

The name of the target group. If omitted, Terraform 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

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.

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.applicationloadbalancing.TargetGroupAttachment(resource_name, opts=None, availability_zone=None, port=None, target_group_arn=None, target_id=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 ``aws_elb_attachment` resource <https://www.terraform.io/docs/providers/aws/r/elb_attachment.html>`_.

Note: aws_alb_target_group_attachment is known as aws_lb_target_group_attachment. 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[int]) – 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.

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.applicationloadbalancing.get_listener(arn=None, load_balancer_arn=None, port=None)
Note: aws_alb_listener is known as aws_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.

pulumi_aws.applicationloadbalancing.get_load_balancer(arn=None, name=None, tags=None)
Note: aws_alb is known as aws_lb. 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.

pulumi_aws.applicationloadbalancing.get_target_group(arn=None, name=None, tags=None)
Note: aws_alb_target_group is known as aws_lb_target_group. 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.