Class CfnCustomerGateway

Specifies a customer gateway.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCustomerGateway

Implements

IInspectable

ICustomerGatewayRef

IConstruct

IDependable

IEnvironmentAware

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.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCustomerGateway : CfnResource, IInspectable, ICustomerGatewayRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnCustomerGateway Inherits CfnResource Implements IInspectable, ICustomerGatewayRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

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.EC2;

             var cfnCustomerGateway = new CfnCustomerGateway(this, "MyCfnCustomerGateway", new CfnCustomerGatewayProps {
                 IpAddress = "ipAddress",
                 Type = "type",

                 // the properties below are optional
                 BgpAsn = 123,
                 BgpAsnExtended = 123,
                 CertificateArn = "certificateArn",
                 DeviceName = "deviceName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnCustomerGateway(Construct, string, ICfnCustomerGatewayProps)

Create a new AWS::EC2::CustomerGateway.

Properties

AttrCustomerGatewayId	The ID of the customer gateway.
BgpAsn	For customer gateway devices that support BGP, specify the device's ASN.
BgpAsnExtended	For customer gateway devices that support BGP, specify the device's ASN.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CertificateArn	The Amazon Resource Name (ARN) for the customer gateway certificate.
CfnProperties	Specifies a customer gateway.
CustomerGatewayRef	A reference to a CustomerGateway resource.
DeviceName	The name of customer gateway device.
IpAddress	The IP address for the customer gateway device's outside interface.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	One or more tags for the customer gateway.
Type	The type of VPN connection that this customer gateway supports ( `ipsec.1` ).

Methods

ArnForCustomerGateway(ICustomerGatewayRef)	Specifies a customer gateway.
FromCustomerGatewayId(Construct, string, string)	Creates a new ICustomerGatewayRef from a customerGatewayId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnCustomerGateway(object)	Checks whether the given object is a CfnCustomerGateway.
RenderProperties(IDictionary<string, object>)	Specifies a customer gateway.

Constructors

CfnCustomerGateway(Construct, string, ICfnCustomerGatewayProps)

Create a new AWS::EC2::CustomerGateway.

public CfnCustomerGateway(Construct scope, string id, ICfnCustomerGatewayProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnCustomerGatewayProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

Properties

AttrCustomerGatewayId

The ID of the customer gateway.

public virtual string AttrCustomerGatewayId { get; }

Property Value

string

Remarks

CloudformationAttribute: CustomerGatewayId

BgpAsn

For customer gateway devices that support BGP, specify the device's ASN.

public virtual double? BgpAsn { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

BgpAsnExtended

For customer gateway devices that support BGP, specify the device's ASN.

public virtual double? BgpAsnExtended { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

CertificateArn

The Amazon Resource Name (ARN) for the customer gateway certificate.

public virtual string? CertificateArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a customer gateway.

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

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

CustomerGatewayRef

A reference to a CustomerGateway resource.

public virtual ICustomerGatewayReference CustomerGatewayRef { get; }

Property Value

ICustomerGatewayReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

DeviceName

The name of customer gateway device.

public virtual string? DeviceName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

IpAddress

The IP address for the customer gateway device's outside interface.

public virtual string IpAddress { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

TagsRaw

One or more tags for the customer gateway.

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

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

Type

The type of VPN connection that this customer gateway supports ( ipsec.1 ).

public virtual string Type { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

Methods

ArnForCustomerGateway(ICustomerGatewayRef)

Specifies a customer gateway.

public static string ArnForCustomerGateway(ICustomerGatewayRef resource)

Parameters

resource ICustomerGatewayRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

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.EC2;

             var cfnCustomerGateway = new CfnCustomerGateway(this, "MyCfnCustomerGateway", new CfnCustomerGatewayProps {
                 IpAddress = "ipAddress",
                 Type = "type",

                 // the properties below are optional
                 BgpAsn = 123,
                 BgpAsnExtended = 123,
                 CertificateArn = "certificateArn",
                 DeviceName = "deviceName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromCustomerGatewayId(Construct, string, string)

Creates a new ICustomerGatewayRef from a customerGatewayId.

public static ICustomerGatewayRef FromCustomerGatewayId(Construct scope, string id, string customerGatewayId)

Parameters

scope Construct
id string
customerGatewayId string

Returns

ICustomerGatewayRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

IsCfnCustomerGateway(object)

Checks whether the given object is a CfnCustomerGateway.

public static bool IsCfnCustomerGateway(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a customer gateway.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

CloudformationResource: AWS::EC2::CustomerGateway

ExampleMetadata: fixture=_generated

Implements

IInspectable

ICustomerGatewayRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable