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/v2/go/aws/globalaccelerator"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

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")

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

Create a Accelerator Resource

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

def Accelerator(resource_name, opts=None, attributes=None, enabled=None, ip_address_type=None, name=None, tags=None, __props__=None);

func NewAccelerator(ctx *Context, name string, args *AcceleratorArgs, opts ...ResourceOption) (*Accelerator, error)

public Accelerator(string name, AcceleratorArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Accelerator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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. The value is true or false. The default value is true.
IpAddressType string: The value for the address type must be IPV4.
Name string: The name of the accelerator.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Attributes AcceleratorAttributes: The attributes of the accelerator. Fields documented below.
Enabled bool: Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
IpAddressType string: The value for the address type must be IPV4.
Name string: The name of the accelerator.
Tags map[string]string: A map of tags to assign to the resource.

attributes AcceleratorAttributes: The attributes of the accelerator. Fields documented below.
enabled boolean: Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
ipAddressType string: The value for the address type must be IPV4.
name string: The name of the accelerator.
tags {[key: string]: string}: A map of tags to assign to the resource.

attributes Dict[AcceleratorAttributes]: The attributes of the accelerator. Fields documented below.
enabled bool: Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
ip_address_type str: The value for the address type must be IPV4.
name str: The name of the accelerator.
tags Dict[str, str]: A map of tags to assign to the resource.

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.

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.

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.

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 List[AcceleratorIpSet]: IP address set associated with the accelerator.

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

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

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)

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.

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. The value is true or false. The default value is true.
HostedZoneId string
IpAddressType string: The value for the address type must be 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.

Attributes AcceleratorAttributes: 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. The value is true or false. The default value is true.
HostedZoneId string
IpAddressType string: The value for the address type must be IPV4.
IpSets []AcceleratorIpSet: 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.

attributes AcceleratorAttributes: 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. The value is true or false. The default value is true.
hostedZoneId string
ipAddressType string: The value for the address type must be IPV4.
ipSets AcceleratorIpSet[]: 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.

attributes Dict[AcceleratorAttributes]: 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. The value is true or false. The default value is true.
hosted_zone_id str
ip_address_type str: The value for the address type must be IPV4.
ip_sets List[AcceleratorIpSet]: IP address set associated with the accelerator.
name str: The name of the accelerator.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

AcceleratorAttributes

See the input and output API doc for this type.

FlowLogsEnabled bool: Indicates whether flow logs are enabled.
FlowLogsS3Bucket string: The name of the Amazon S3 bucket for the flow logs.
FlowLogsS3Prefix string: The prefix for the location in the Amazon S3 bucket for the flow logs.

FlowLogsEnabled bool: Indicates whether flow logs are enabled.
FlowLogsS3Bucket string: The name of the Amazon S3 bucket for the flow logs.
FlowLogsS3Prefix string: The prefix for the location in the Amazon S3 bucket for the flow logs.

flowLogsEnabled boolean: Indicates whether flow logs are enabled.
flowLogsS3Bucket string: The name of the Amazon S3 bucket for the flow logs.
flowLogsS3Prefix string: The prefix for the location in the Amazon S3 bucket for the flow logs.

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.

AcceleratorIpSet

See the output API doc for this type.

IpAddresses List<string>: A list of IP addresses in the IP address set.
IpFamily string: The types of IP addresses included in this IP set.

IpAddresses []string: A list of IP addresses in the IP address set.
IpFamily string: The types of IP addresses included in this IP set.

ipAddresses string[]: A list of IP addresses in the IP address set.
ipFamily string: The types of IP addresses included in this IP set.

ipFamily str: The types of IP addresses included in this IP set.
ip_addresses List[str]: A list of IP addresses in the IP address set.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud