This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

globalaccelerator¶

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.globalaccelerator.Accelerator(resource_name, opts=None, attributes=None, enabled=None, ip_address_type=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Creates a Global Accelerator accelerator.

import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.Accelerator("example",
    attributes={
        "flowLogsEnabled": True,
        "flowLogsS3Bucket": "example-bucket",
        "flowLogsS3Prefix": "flow-logs/",
    },
    enabled=True,
    ip_address_type="IPV4")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
attributes (pulumi.Input[dict]) – The attributes of the accelerator. Fields documented below.
enabled (pulumi.Input[bool]) – Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
ip_address_type (pulumi.Input[str]) – The value for the address type must be IPV4.
name (pulumi.Input[str]) – The name of the accelerator.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The attributes object supports the following:

flowLogsEnabled (pulumi.Input[bool]) - Indicates whether flow logs are enabled.
flowLogsS3Bucket (pulumi.Input[str]) - The name of the Amazon S3 bucket for the flow logs.
flowLogsS3Prefix (pulumi.Input[str]) - The prefix for the location in the Amazon S3 bucket for the flow logs.

attributes: pulumi.Output[dict] = None¶

The attributes of the accelerator. Fields documented below.

flowLogsEnabled (bool) - Indicates whether flow logs are enabled.
flowLogsS3Bucket (str) - The name of the Amazon S3 bucket for the flow logs.
flowLogsS3Prefix (str) - The prefix for the location in the Amazon S3 bucket for the flow logs.

dns_name: pulumi.Output[str] = None¶

The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.

hosted_zone_id – The Global Accelerator Route 53 zone ID that can be used to route an Alias Resource Record Set to the Global Accelerator. This attribute is simply an alias for the zone ID Z2BJ6XQ5FK7U4H.

enabled: pulumi.Output[bool] = None¶: Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

ip_address_type: pulumi.Output[str] = None¶: The value for the address type must be IPV4.

ip_sets: pulumi.Output[list] = None¶

IP address set associated with the accelerator.

ip_addresses (list) - A list of IP addresses in the IP address set.
ipFamily (str) - The types of IP addresses included in this IP set.

name: pulumi.Output[str] = None¶: The name of the accelerator.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, attributes=None, dns_name=None, enabled=None, hosted_zone_id=None, ip_address_type=None, ip_sets=None, name=None, tags=None)¶

Get an existing Accelerator 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.
attributes (pulumi.Input[dict]) – The attributes of the accelerator. Fields documented below.
dns_name (pulumi.Input[str]) – The DNS name of the accelerator. For example, a5d53ff5ee6bca4ce.awsglobalaccelerator.com.

* `hosted_zone_id` --  The Global Accelerator Route 53 zone ID that can be used to
route an [Alias Resource Record Set](https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html) to the Global Accelerator. This attribute
is simply an alias for the zone ID `Z2BJ6XQ5FK7U4H`.

Parameters

enabled (pulumi.Input[bool]) – Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
ip_address_type (pulumi.Input[str]) – The value for the address type must be IPV4.
ip_sets (pulumi.Input[list]) – IP address set associated with the accelerator.
name (pulumi.Input[str]) – The name of the accelerator.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The attributes object supports the following:

flowLogsEnabled (pulumi.Input[bool]) - Indicates whether flow logs are enabled.
flowLogsS3Bucket (pulumi.Input[str]) - The name of the Amazon S3 bucket for the flow logs.
flowLogsS3Prefix (pulumi.Input[str]) - The prefix for the location in the Amazon S3 bucket for the flow logs.

The ip_sets object supports the following:

ip_addresses (pulumi.Input[list]) - A list of IP addresses in the IP address set.
ipFamily (pulumi.Input[str]) - The types of IP addresses included in this IP set.

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.globalaccelerator.EndpointGroup(resource_name, opts=None, endpoint_configurations=None, endpoint_group_region=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, listener_arn=None, threshold_count=None, traffic_dial_percentage=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Global Accelerator endpoint group.

import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.EndpointGroup("example",
    endpoint_configurations=[{
        "endpoint_id": aws_lb["example"]["arn"],
        "weight": 100,
    }],
    listener_arn=aws_globalaccelerator_listener["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoint_configurations (pulumi.Input[list]) – The list of endpoint objects. Fields documented below.
endpoint_group_region (pulumi.Input[str]) – The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds (pulumi.Input[float]) – The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
health_check_path (pulumi.Input[str]) – If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
health_check_port (pulumi.Input[float]) – The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
health_check_protocol (pulumi.Input[str]) – The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listener_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the listener.
threshold_count (pulumi.Input[float]) – The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
traffic_dial_percentage (pulumi.Input[float]) – The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.

The endpoint_configurations object supports the following:

endpoint_id (pulumi.Input[str]) - An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight (pulumi.Input[float]) - The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.

endpoint_configurations: pulumi.Output[list] = None¶

The list of endpoint objects. Fields documented below.

endpoint_id (str) - An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight (float) - The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.

endpoint_group_region: pulumi.Output[str] = None¶: The name of the AWS Region where the endpoint group is located.

health_check_interval_seconds: pulumi.Output[float] = None¶: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

health_check_path: pulumi.Output[str] = None¶: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

health_check_port: pulumi.Output[float] = None¶: The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

health_check_protocol: pulumi.Output[str] = None¶: The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

listener_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the listener.

threshold_count: pulumi.Output[float] = None¶: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

traffic_dial_percentage: pulumi.Output[float] = None¶: The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.

static get(resource_name, id, opts=None, endpoint_configurations=None, endpoint_group_region=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, listener_arn=None, threshold_count=None, traffic_dial_percentage=None)¶

Get an existing EndpointGroup 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.
endpoint_configurations (pulumi.Input[list]) – The list of endpoint objects. Fields documented below.
endpoint_group_region (pulumi.Input[str]) – The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds (pulumi.Input[float]) – The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
health_check_path (pulumi.Input[str]) – If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
health_check_port (pulumi.Input[float]) – The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
health_check_protocol (pulumi.Input[str]) – The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listener_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the listener.
threshold_count (pulumi.Input[float]) – The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
traffic_dial_percentage (pulumi.Input[float]) – The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.

The endpoint_configurations object supports the following:

endpoint_id (pulumi.Input[str]) - An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight (pulumi.Input[float]) - The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.

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.globalaccelerator.Listener(resource_name, opts=None, accelerator_arn=None, client_affinity=None, port_ranges=None, protocol=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Global Accelerator listener.

import pulumi
import pulumi_aws as aws

example_accelerator = aws.globalaccelerator.Accelerator("exampleAccelerator",
    attributes={
        "flowLogsEnabled": True,
        "flowLogsS3Bucket": "example-bucket",
        "flowLogsS3Prefix": "flow-logs/",
    },
    enabled=True,
    ip_address_type="IPV4")
example_listener = aws.globalaccelerator.Listener("exampleListener",
    accelerator_arn=example_accelerator.id,
    client_affinity="SOURCE_IP",
    port_ranges=[{
        "from_port": 80,
        "to_port": 80,
    }],
    protocol="TCP")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
accelerator_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of your accelerator.
client_affinity (pulumi.Input[str]) – Direct all requests from a user to the same endpoint. Valid values are NONE, SOURCE_IP. Default: NONE. If NONE, Global Accelerator uses the “five-tuple” properties of source IP address, source port, destination IP address, destination port, and protocol to select the hash value. If SOURCE_IP, Global Accelerator uses the “two-tuple” properties of source (client) IP address and destination IP address to select the hash value.
port_ranges (pulumi.Input[list]) – The list of port ranges for the connections from clients to the accelerator. Fields documented below.
protocol (pulumi.Input[str]) – The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

The port_ranges object supports the following:

from_port (pulumi.Input[float]) - The first port in the range of ports, inclusive.
to_port (pulumi.Input[float]) - The last port in the range of ports, inclusive.

accelerator_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of your accelerator.

client_affinity: pulumi.Output[str] = None¶: Direct all requests from a user to the same endpoint. Valid values are NONE, SOURCE_IP. Default: NONE. If NONE, Global Accelerator uses the “five-tuple” properties of source IP address, source port, destination IP address, destination port, and protocol to select the hash value. If SOURCE_IP, Global Accelerator uses the “two-tuple” properties of source (client) IP address and destination IP address to select the hash value.

port_ranges: pulumi.Output[list] = None¶

The list of port ranges for the connections from clients to the accelerator. Fields documented below.

from_port (float) - The first port in the range of ports, inclusive.
to_port (float) - The last port in the range of ports, inclusive.

protocol: pulumi.Output[str] = None¶: The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

static get(resource_name, id, opts=None, accelerator_arn=None, client_affinity=None, port_ranges=None, protocol=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.
accelerator_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of your accelerator.
client_affinity (pulumi.Input[str]) – Direct all requests from a user to the same endpoint. Valid values are NONE, SOURCE_IP. Default: NONE. If NONE, Global Accelerator uses the “five-tuple” properties of source IP address, source port, destination IP address, destination port, and protocol to select the hash value. If SOURCE_IP, Global Accelerator uses the “two-tuple” properties of source (client) IP address and destination IP address to select the hash value.
port_ranges (pulumi.Input[list]) – The list of port ranges for the connections from clients to the accelerator. Fields documented below.
protocol (pulumi.Input[str]) – The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

The port_ranges object supports the following:

from_port (pulumi.Input[float]) - The first port in the range of ports, inclusive.
to_port (pulumi.Input[float]) - The last port in the range of ports, inclusive.

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

globalaccelerator¶

On This Page