1. Packages
  2. AWS Native
  3. API Docs
  4. globalaccelerator
  5. Accelerator

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.globalaccelerator.Accelerator

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource Type definition for AWS::GlobalAccelerator::Accelerator

    Create Accelerator Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Accelerator(name: string, args?: AcceleratorArgs, opts?: CustomResourceOptions);
    @overload
    def Accelerator(resource_name: str,
                    args: Optional[AcceleratorArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Accelerator(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    enabled: Optional[bool] = None,
                    ip_address_type: Optional[AcceleratorIpAddressType] = None,
                    ip_addresses: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:globalaccelerator:Accelerator
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const acceleratorResource = new aws_native.globalaccelerator.Accelerator("acceleratorResource", {
        enabled: false,
        ipAddressType: aws_native.globalaccelerator.AcceleratorIpAddressType.Ipv4,
        ipAddresses: ["string"],
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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:

    Enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    IpAddressType Pulumi.AwsNative.GlobalAccelerator.AcceleratorIpAddressType
    IP Address type.
    IpAddresses List<string>
    The IP addresses from BYOIP Prefix pool.
    Name string
    Name of accelerator.
    Tags List<Pulumi.AwsNative.Inputs.Tag>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    Enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    IpAddressType AcceleratorIpAddressType
    IP Address type.
    IpAddresses []string
    The IP addresses from BYOIP Prefix pool.
    Name string
    Name of accelerator.
    Tags TagArgs

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    enabled Boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType AcceleratorIpAddressType
    IP Address type.
    ipAddresses List<String>
    The IP addresses from BYOIP Prefix pool.
    name String
    Name of accelerator.
    tags List<Tag>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    enabled boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType AcceleratorIpAddressType
    IP Address type.
    ipAddresses string[]
    The IP addresses from BYOIP Prefix pool.
    name string
    Name of accelerator.
    tags Tag[]

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    enabled bool
    Indicates whether an accelerator is enabled. The value is true or false.
    ip_address_type AcceleratorIpAddressType
    IP Address type.
    ip_addresses Sequence[str]
    The IP addresses from BYOIP Prefix pool.
    name str
    Name of accelerator.
    tags Sequence[TagArgs]

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    enabled Boolean
    Indicates whether an accelerator is enabled. The value is true or false.
    ipAddressType "IPV4" | "DUAL_STACK"
    IP Address type.
    ipAddresses List<String>
    The IP addresses from BYOIP Prefix pool.
    name String
    Name of accelerator.
    tags List<Property Map>

    Create tags for an accelerator.

    For more information, see Tagging in the AWS Global Accelerator Developer Guide .

    Outputs

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

    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    DnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4Addresses List<string>
    The IPv4 addresses assigned to the accelerator.
    Ipv6Addresses List<string>
    The IPv6 addresses assigned if the accelerator is dualstack
    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    DnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    DualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4Addresses []string
    The IPv4 addresses assigned to the accelerator.
    Ipv6Addresses []string
    The IPv6 addresses assigned if the accelerator is dualstack
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4Addresses List<String>
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses List<String>
    The IPv6 addresses assigned if the accelerator is dualstack
    acceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName string
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv4Addresses string[]
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses string[]
    The IPv6 addresses assigned if the accelerator is dualstack
    accelerator_arn str
    The Amazon Resource Name (ARN) of the accelerator.
    dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dual_stack_dns_name str
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv4_addresses Sequence[str]
    The IPv4 addresses assigned to the accelerator.
    ipv6_addresses Sequence[str]
    The IPv6 addresses assigned if the accelerator is dualstack
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    dnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
    dualStackDnsName String
    The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4Addresses List<String>
    The IPv4 addresses assigned to the accelerator.
    ipv6Addresses List<String>
    The IPv6 addresses assigned if the accelerator is dualstack

    Supporting Types

    AcceleratorIpAddressType, AcceleratorIpAddressTypeArgs

    Ipv4
    IPV4
    DualStack
    DUAL_STACK
    AcceleratorIpAddressTypeIpv4
    IPV4
    AcceleratorIpAddressTypeDualStack
    DUAL_STACK
    Ipv4
    IPV4
    DualStack
    DUAL_STACK
    Ipv4
    IPV4
    DualStack
    DUAL_STACK
    IPV4
    IPV4
    DUAL_STACK
    DUAL_STACK
    "IPV4"
    IPV4
    "DUAL_STACK"
    DUAL_STACK

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi