Module globalaccelerator

@pulumi/aws > globalaccelerator

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",
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 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",
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 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.