AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Accelerator

Creates a Global Accelerator accelerator.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.GlobalAccelerator.Accelerator("example", new Aws.GlobalAccelerator.AcceleratorArgs
        {
            Attributes = new Aws.GlobalAccelerator.Inputs.AcceleratorAttributesArgs
            {
                FlowLogsEnabled = true,
                FlowLogsS3Bucket = "example-bucket",
                FlowLogsS3Prefix = "flow-logs/",
            },
            Enabled = true,
            IpAddressType = "IPV4",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/globalaccelerator"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globalaccelerator.NewAccelerator(ctx, "example", &globalaccelerator.AcceleratorArgs{
			Attributes: &globalaccelerator.AcceleratorAttributesArgs{
				FlowLogsEnabled:  pulumi.Bool(true),
				FlowLogsS3Bucket: pulumi.String("example-bucket"),
				FlowLogsS3Prefix: pulumi.String("flow-logs/"),
			},
			Enabled:       pulumi.Bool(true),
			IpAddressType: pulumi.String("IPV4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Accelerator("example", AcceleratorArgs.builder()        
            .attributes(AcceleratorAttributesArgs.builder()
                .flowLogsEnabled(true)
                .flowLogsS3Bucket("example-bucket")
                .flowLogsS3Prefix("flow-logs/")
                .build())
            .enabled(true)
            .ipAddressType("IPV4")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.Accelerator("example",
    attributes=aws.globalaccelerator.AcceleratorAttributesArgs(
        flow_logs_enabled=True,
        flow_logs_s3_bucket="example-bucket",
        flow_logs_s3_prefix="flow-logs/",
    ),
    enabled=True,
    ip_address_type="IPV4")
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",
});
resources:
  example:
    type: aws:globalaccelerator:Accelerator
    properties:
      attributes:
        flowLogsEnabled: true
        flowLogsS3Bucket: example-bucket
        flowLogsS3Prefix: flow-logs/
      enabled: true
      ipAddressType: IPV4

Create a Accelerator Resource

new Accelerator(name: string, args?: AcceleratorArgs, opts?: CustomResourceOptions);
@overload
def Accelerator(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                attributes: Optional[AcceleratorAttributesArgs] = None,
                enabled: Optional[bool] = None,
                ip_address_type: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def Accelerator(resource_name: str,
                args: Optional[AcceleratorArgs] = None,
                opts: Optional[ResourceOptions] = None)
func NewAccelerator(ctx *Context, name string, args *AcceleratorArgs, opts ...ResourceOption) (*Accelerator, error)
public Accelerator(string name, AcceleratorArgs? args = null, CustomResourceOptions? opts = null)
public Accelerator(String name, AcceleratorArgs args)
public Accelerator(String name, AcceleratorArgs args, CustomResourceOptions options)
type: aws:globalaccelerator:Accelerator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AcceleratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AcceleratorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AcceleratorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AcceleratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AcceleratorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Accelerator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Accelerator resource accepts the following input properties:

Attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

Enabled bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

IpAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

Name string

The name of the accelerator.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

Enabled bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

IpAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

Name string

The name of the accelerator.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

enabled Boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

ipAddressType String

The value for the address type. Defaults to IPV4. Valid values: IPV4.

name String

The name of the accelerator.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

enabled boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

ipAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

name string

The name of the accelerator.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

enabled bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

ip_address_type str

The value for the address type. Defaults to IPV4. Valid values: IPV4.

name str

The name of the accelerator.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

attributes Property Map

The attributes of the accelerator. Fields documented below.

enabled Boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

ipAddressType String

The value for the address type. Defaults to IPV4. Valid values: IPV4.

name String

The name of the accelerator.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Accelerator resource produces the following output properties:

DnsName string

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.
HostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

IpSets List<AcceleratorIpSet>

IP address set associated with the accelerator.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

DnsName string

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.
HostedZoneId string
Id string

The provider-assigned unique ID for this managed resource.

IpSets []AcceleratorIpSet

IP address set associated with the accelerator.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

dnsName String

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.
hostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

ipSets List<AcceleratorIpSet>

IP address set associated with the accelerator.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

dnsName string

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.
hostedZoneId string
id string

The provider-assigned unique ID for this managed resource.

ipSets AcceleratorIpSet[]

IP address set associated with the accelerator.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

dns_name 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 to the Global Accelerator. This attribute is simply an alias for the zone ID Z2BJ6XQ5FK7U4H.
hosted_zone_id str
id str

The provider-assigned unique ID for this managed resource.

ip_sets Sequence[AcceleratorIpSet]

IP address set associated with the accelerator.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

dnsName String

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.
hostedZoneId String
id String

The provider-assigned unique ID for this managed resource.

ipSets List<Property Map>

IP address set associated with the accelerator.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

Look up an Existing Accelerator Resource

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

public static get(name: string, id: Input<ID>, state?: AcceleratorState, opts?: CustomResourceOptions): Accelerator
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[AcceleratorAttributesArgs] = None,
        dns_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        hosted_zone_id: Optional[str] = None,
        ip_address_type: Optional[str] = None,
        ip_sets: Optional[Sequence[AcceleratorIpSetArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Accelerator
func GetAccelerator(ctx *Context, name string, id IDInput, state *AcceleratorState, opts ...ResourceOption) (*Accelerator, error)
public static Accelerator Get(string name, Input<string> id, AcceleratorState? state, CustomResourceOptions? opts = null)
public static Accelerator get(String name, Output<String> id, AcceleratorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

DnsName string

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 bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

HostedZoneId string
IpAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

IpSets List<AcceleratorIpSetArgs>

IP address set associated with the accelerator.

Name string

The name of the accelerator.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

DnsName string

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 bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

HostedZoneId string
IpAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

IpSets []AcceleratorIpSetArgs

IP address set associated with the accelerator.

Name string

The name of the accelerator.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

dnsName String

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 Boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

hostedZoneId String
ipAddressType String

The value for the address type. Defaults to IPV4. Valid values: IPV4.

ipSets List<AcceleratorIpSetArgs>

IP address set associated with the accelerator.

name String

The name of the accelerator.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

dnsName string

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 boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

hostedZoneId string
ipAddressType string

The value for the address type. Defaults to IPV4. Valid values: IPV4.

ipSets AcceleratorIpSetArgs[]

IP address set associated with the accelerator.

name string

The name of the accelerator.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

attributes AcceleratorAttributesArgs

The attributes of the accelerator. Fields documented below.

dns_name 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 to the Global Accelerator. This attribute is simply an alias for the zone ID Z2BJ6XQ5FK7U4H.
enabled bool

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

hosted_zone_id str
ip_address_type str

The value for the address type. Defaults to IPV4. Valid values: IPV4.

ip_sets Sequence[AcceleratorIpSetArgs]

IP address set associated with the accelerator.

name str

The name of the accelerator.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

attributes Property Map

The attributes of the accelerator. Fields documented below.

dnsName String

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 Boolean

Indicates whether the accelerator is enabled. Defaults to true. Valid values: true, false.

hostedZoneId String
ipAddressType String

The value for the address type. Defaults to IPV4. Valid values: IPV4.

ipSets List<Property Map>

IP address set associated with the accelerator.

name String

The name of the accelerator.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

Supporting Types

AcceleratorAttributes

FlowLogsEnabled bool

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

FlowLogsS3Bucket string

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

FlowLogsS3Prefix string

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

FlowLogsEnabled bool

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

FlowLogsS3Bucket string

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

FlowLogsS3Prefix string

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsEnabled Boolean

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

flowLogsS3Bucket String

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsS3Prefix String

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsEnabled boolean

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

flowLogsS3Bucket string

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsS3Prefix string

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flow_logs_enabled bool

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

flow_logs_s3_bucket str

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flow_logs_s3_prefix str

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsEnabled Boolean

Indicates whether flow logs are enabled. Defaults to false. Valid values: true, false.

flowLogsS3Bucket String

The name of the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

flowLogsS3Prefix String

The prefix for the location in the Amazon S3 bucket for the flow logs. Required if flow_logs_enabled is true.

AcceleratorIpSet

IpAddresses List<string>

A list of IP addresses in the IP address set.

IpFamily string

The type of IP addresses included in this IP set.

IpAddresses []string

A list of IP addresses in the IP address set.

IpFamily string

The type of IP addresses included in this IP set.

ipAddresses List<String>

A list of IP addresses in the IP address set.

ipFamily String

The type of IP addresses included in this IP set.

ipAddresses string[]

A list of IP addresses in the IP address set.

ipFamily string

The type of IP addresses included in this IP set.

ip_addresses Sequence[str]

A list of IP addresses in the IP address set.

ip_family str

The type of IP addresses included in this IP set.

ipAddresses List<String>

A list of IP addresses in the IP address set.

ipFamily String

The type of IP addresses included in this IP set.

Import

Global Accelerator accelerators can be imported using the arn, e.g.,

 $ pulumi import aws:globalaccelerator/accelerator:Accelerator example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.