Module globalaccelerator

@pulumi/aws > 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 Accelerator

extends CustomResource

Provides a Global Accelerator accelerator.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.globalaccelerator.Accelerator("example", {
    attributes: {
        flowLogsEnabled: true,
        flowLogsS3Bucket: "example-bucket",
        flowLogsS3Prefix: "flow-logs/",
    },
    enabled: true,
    ipAddressType: "IPV4",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/globalaccelerator_accelerator.html.markdown.

constructor

new Accelerator(name: string, args?: AcceleratorArgs, opts?: pulumi.CustomResourceOptions)

Create a Accelerator resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AcceleratorState, opts?: pulumi.CustomResourceOptions): Accelerator

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Accelerator. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attributes

public attributes: pulumi.Output<{
    flowLogsEnabled: undefined | false | true;
    flowLogsS3Bucket: undefined | string;
    flowLogsS3Prefix: undefined | string;
} | undefined>;

The attributes of the accelerator. Fields documented below.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddressType

public ipAddressType: pulumi.Output<string | undefined>;

The value for the address type must be IPV4.

property ipSets

public ipSets: pulumi.Output<{
    ipAddresses: string[];
    ipFamily: string;
}[]>;

IP address set associated with the accelerator.

property name

public name: pulumi.Output<string>;

The name of the accelerator.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class EndpointGroup

extends CustomResource

Provides a Global Accelerator endpoint group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.globalaccelerator.EndpointGroup("example", {
    endpointConfigurations: [{
        endpointId: aws_lb_example.arn,
        weight: 100,
    }],
    listenerArn: aws_globalaccelerator_listener_example.id,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/globalaccelerator_endpoint_group.html.markdown.

constructor

new EndpointGroup(name: string, args: EndpointGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointGroupState, opts?: pulumi.CustomResourceOptions): EndpointGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of EndpointGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpointConfigurations

public endpointConfigurations: pulumi.Output<{
    endpointId: undefined | string;
    weight: undefined | number;
}[] | undefined>;

The list of endpoint objects. Fields documented below.

property endpointGroupRegion

public endpointGroupRegion: pulumi.Output<string>;

property healthCheckIntervalSeconds

public healthCheckIntervalSeconds: pulumi.Output<number | undefined>;

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

property healthCheckPath

public healthCheckPath: pulumi.Output<string | undefined>;

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

property healthCheckPort

public healthCheckPort: pulumi.Output<number | undefined>;

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.

property healthCheckProtocol

public healthCheckProtocol: pulumi.Output<string | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property listenerArn

public listenerArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the listener.

property thresholdCount

public thresholdCount: pulumi.Output<number | undefined>;

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.

property trafficDialPercentage

public trafficDialPercentage: pulumi.Output<number | undefined>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Listener

extends CustomResource

Provides a Global Accelerator listener.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleAccelerator = new aws.globalaccelerator.Accelerator("example", {
    attributes: {
        flowLogsEnabled: true,
        flowLogsS3Bucket: "example-bucket",
        flowLogsS3Prefix: "flow-logs/",
    },
    enabled: true,
    ipAddressType: "IPV4",
});
const exampleListener = new aws.globalaccelerator.Listener("example", {
    acceleratorArn: exampleAccelerator.id,
    clientAffinity: "SOURCE_IP",
    portRanges: [{
        fromPort: 80,
        toPort: 80,
    }],
    protocol: "TCP",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/globalaccelerator_listener.html.markdown.

constructor

new Listener(name: string, args: ListenerArgs, opts?: pulumi.CustomResourceOptions)

Create a Listener resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ListenerState, opts?: pulumi.CustomResourceOptions): Listener

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Listener. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property acceleratorArn

public acceleratorArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of your accelerator.

property clientAffinity

public clientAffinity: pulumi.Output<string | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property portRanges

public portRanges: pulumi.Output<{
    fromPort: undefined | number;
    toPort: undefined | number;
}[]>;

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

property protocol

public protocol: pulumi.Output<string>;

The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface AcceleratorArgs

The set of arguments for constructing a Accelerator resource.

property attributes

attributes?: pulumi.Input<{
    flowLogsEnabled: pulumi.Input<boolean>;
    flowLogsS3Bucket: pulumi.Input<string>;
    flowLogsS3Prefix: pulumi.Input<string>;
}>;

The attributes of the accelerator. Fields documented below.

property enabled

enabled?: pulumi.Input<boolean>;

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

property ipAddressType

ipAddressType?: pulumi.Input<string>;

The value for the address type must be IPV4.

property name

name?: pulumi.Input<string>;

The name of the accelerator.

interface AcceleratorState

Input properties used for looking up and filtering Accelerator resources.

property attributes

attributes?: pulumi.Input<{
    flowLogsEnabled: pulumi.Input<boolean>;
    flowLogsS3Bucket: pulumi.Input<string>;
    flowLogsS3Prefix: pulumi.Input<string>;
}>;

The attributes of the accelerator. Fields documented below.

property enabled

enabled?: pulumi.Input<boolean>;

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

property ipAddressType

ipAddressType?: pulumi.Input<string>;

The value for the address type must be IPV4.

property ipSets

ipSets?: pulumi.Input<pulumi.Input<{
    ipAddresses: pulumi.Input<pulumi.Input<string>[]>;
    ipFamily: pulumi.Input<string>;
}>[]>;

IP address set associated with the accelerator.

property name

name?: pulumi.Input<string>;

The name of the accelerator.

interface EndpointGroupArgs

The set of arguments for constructing a EndpointGroup resource.

property endpointConfigurations

endpointConfigurations?: pulumi.Input<pulumi.Input<{
    endpointId: pulumi.Input<string>;
    weight: pulumi.Input<number>;
}>[]>;

The list of endpoint objects. Fields documented below.

property endpointGroupRegion

endpointGroupRegion?: pulumi.Input<string>;

property healthCheckIntervalSeconds

healthCheckIntervalSeconds?: pulumi.Input<number>;

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

property healthCheckPath

healthCheckPath?: pulumi.Input<string>;

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

property healthCheckPort

healthCheckPort?: pulumi.Input<number>;

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.

property healthCheckProtocol

healthCheckProtocol?: pulumi.Input<string>;

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.

property listenerArn

listenerArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the listener.

property thresholdCount

thresholdCount?: pulumi.Input<number>;

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.

property trafficDialPercentage

trafficDialPercentage?: pulumi.Input<number>;

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.

interface EndpointGroupState

Input properties used for looking up and filtering EndpointGroup resources.

property endpointConfigurations

endpointConfigurations?: pulumi.Input<pulumi.Input<{
    endpointId: pulumi.Input<string>;
    weight: pulumi.Input<number>;
}>[]>;

The list of endpoint objects. Fields documented below.

property endpointGroupRegion

endpointGroupRegion?: pulumi.Input<string>;

property healthCheckIntervalSeconds

healthCheckIntervalSeconds?: pulumi.Input<number>;

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

property healthCheckPath

healthCheckPath?: pulumi.Input<string>;

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

property healthCheckPort

healthCheckPort?: pulumi.Input<number>;

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.

property healthCheckProtocol

healthCheckProtocol?: pulumi.Input<string>;

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.

property listenerArn

listenerArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the listener.

property thresholdCount

thresholdCount?: pulumi.Input<number>;

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.

property trafficDialPercentage

trafficDialPercentage?: pulumi.Input<number>;

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.

interface ListenerArgs

The set of arguments for constructing a Listener resource.

property acceleratorArn

acceleratorArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of your accelerator.

property clientAffinity

clientAffinity?: pulumi.Input<string>;

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.

property portRanges

portRanges: pulumi.Input<pulumi.Input<{
    fromPort: pulumi.Input<number>;
    toPort: pulumi.Input<number>;
}>[]>;

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

property protocol

protocol: pulumi.Input<string>;

The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.

interface ListenerState

Input properties used for looking up and filtering Listener resources.

property acceleratorArn

acceleratorArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of your accelerator.

property clientAffinity

clientAffinity?: pulumi.Input<string>;

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.

property portRanges

portRanges?: pulumi.Input<pulumi.Input<{
    fromPort: pulumi.Input<number>;
    toPort: pulumi.Input<number>;
}>[]>;

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

property protocol

protocol?: pulumi.Input<string>;

The protocol for the connections from clients to the accelerator. Valid values are TCP, UDP.