Class CfnAccelerator

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAccelerator

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.GlobalAccelerator

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccelerator : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnAccelerator Inherits CfnResource Implements IInspectable, ITaggable

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GlobalAccelerator;

             var cfnAccelerator = new CfnAccelerator(this, "MyCfnAccelerator", new CfnAcceleratorProps {
                 Name = "name",

                 // the properties below are optional
                 Enabled = false,
                 IpAddresses = new [] { "ipAddresses" },
                 IpAddressType = "ipAddressType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnAccelerator(Construct, string, ICfnAcceleratorProps)

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

Properties

AttrAcceleratorArn	The ARN of the accelerator, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh .
AttrDnsName	The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
AttrDualStackDnsName	The DNS name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.
AttrIpv4Addresses	The array of IPv4 addresses in the IP address set.
AttrIpv6Addresses	The array of IPv6 addresses in the IP address set.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.
Enabled	Indicates whether the accelerator is enabled.
IpAddressType	The IP address type that an accelerator supports.
IpAddresses	Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.
Name	The name of the accelerator.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Create tags for an accelerator.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

Constructors

CfnAccelerator(Construct, string, ICfnAcceleratorProps)

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

public CfnAccelerator(Construct scope, string id, ICfnAcceleratorProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAcceleratorProps

Resource properties.

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Properties

AttrAcceleratorArn

The ARN of the accelerator, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh .

public virtual string AttrAcceleratorArn { get; }

Property Value

string

Remarks

CloudformationAttribute: AcceleratorArn

AttrDnsName

The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

public virtual string AttrDnsName { get; }

Property Value

string

Remarks

CloudformationAttribute: DnsName

AttrDualStackDnsName

The DNS name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

public virtual string AttrDualStackDnsName { get; }

Property Value

string

Remarks

CloudformationAttribute: DualStackDnsName

AttrIpv4Addresses

The array of IPv4 addresses in the IP address set.

public virtual string[] AttrIpv4Addresses { get; }

Property Value

string[]

Remarks

An IP address set can have a maximum of two IP addresses.

CloudformationAttribute: Ipv4Addresses

AttrIpv6Addresses

The array of IPv6 addresses in the IP address set.

public virtual string[] AttrIpv6Addresses { get; }

Property Value

string[]

Remarks

An IP address set can have a maximum of two IP addresses.

CloudformationAttribute: Ipv6Addresses

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Enabled

Indicates whether the accelerator is enabled.

public virtual object? Enabled { get; set; }

Property Value

object

Remarks

The value is true or false. The default value is true.

IpAddressType

The IP address type that an accelerator supports.

public virtual string? IpAddressType { get; set; }

Property Value

string

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

IpAddresses

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.

public virtual string[]? IpAddresses { get; set; }

Property Value

string[]

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Name

The name of the accelerator.

public virtual string Name { get; set; }

Property Value

string

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

TagsRaw

Create tags for an accelerator.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

CloudformationResource: AWS::GlobalAccelerator::Accelerator

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable