Module globalaccelerator

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

Provides a Global Accelerator accelerator.

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.
attributes = None

The attributes of the accelerator. Fields documented below.

enabled = None

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

ip_address_type = None

The value for the address type must be IPV4.

ip_sets = None

IP address set associated with the accelerator.

name = None

The name of the accelerator.

static get(resource_name, id, opts=None, attributes=None, enabled=None, ip_address_type=None, ip_sets=None, name=None)

Get an existing Accelerator resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] attributes: The attributes of the accelerator. Fields documented below. :param pulumi.Input[bool] enabled: Indicates whether the accelerator is enabled. The value is true or false. The default value is true. :param pulumi.Input[str] ip_address_type: The value for the address type must be IPV4. :param pulumi.Input[list] ip_sets: IP address set associated with the accelerator. :param pulumi.Input[str] name: The name of the accelerator.

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.

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.
  • 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.
endpoint_configurations = None

The list of endpoint objects. Fields documented below.

health_check_interval_seconds = None

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

health_check_path = 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 = 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 = 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 = None

The Amazon Resource Name (ARN) of the listener.

threshold_count = 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 = 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. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] endpoint_configurations: The list of endpoint objects. Fields documented below. :param pulumi.Input[float] health_check_interval_seconds: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. :param pulumi.Input[str] health_check_path: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). :param pulumi.Input[float] health_check_port: 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. :param pulumi.Input[str] health_check_protocol: 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. :param pulumi.Input[str] listener_arn: The Amazon Resource Name (ARN) of the listener. :param pulumi.Input[float] threshold_count: 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. :param pulumi.Input[float] traffic_dial_percentage: 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.

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.

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.
accelerator_arn = None

The Amazon Resource Name (ARN) of your accelerator.

client_affinity = 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 = None

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

protocol = 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. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] accelerator_arn: The Amazon Resource Name (ARN) of your accelerator. :param pulumi.Input[str] client_affinity: 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. :param pulumi.Input[list] port_ranges: The list of port ranges for the connections from clients to the accelerator. Fields documented below. :param pulumi.Input[str] protocol: The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

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