Show / Hide Table of Contents

Class CfnCustomerGateway

A CloudFormation AWS::EC2::CustomerGateway.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnCustomerGateway
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnCustomerGateway : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCustomerGateway
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

Specifies a customer gateway.

CloudformationResource: AWS::EC2::CustomerGateway

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

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 {
    BgpAsn = 123,
    IpAddress = "ipAddress",
    Type = "type",

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

Synopsis

Constructors

CfnCustomerGateway(Construct, String, ICfnCustomerGatewayProps)

Create a new AWS::EC2::CustomerGateway.

CfnCustomerGateway(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnCustomerGateway(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrCustomerGatewayId

The ID of the customer gateway.

BgpAsn

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
DeviceName

The name of customer gateway device.

IpAddress

IPv4 address for the customer gateway device's outside interface.

Tags

One or more tags for the customer gateway.

Type

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

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 System.String
  • scoped id of the resource.
props ICfnCustomerGatewayProps
  • resource properties.

CfnCustomerGateway(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnCustomerGateway(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnCustomerGateway(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnCustomerGateway(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrCustomerGatewayId

The ID of the customer gateway.

public virtual string AttrCustomerGatewayId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CustomerGatewayId

BgpAsn

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

public virtual double BgpAsn { get; set; }
Property Value

System.Double

Remarks

Default: 65000

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

DeviceName

The name of customer gateway device.

public virtual string DeviceName { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename

IpAddress

IPv4 address for the customer gateway device's outside interface.

public virtual string IpAddress { get; set; }
Property Value

System.String

Remarks

The address must be static.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress

Tags

One or more tags for the customer gateway.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags

Type

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

public virtual string Type { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct
Constructs.IConstruct
IDependable
IInspectable
Back to top Generated by DocFX