Class CfnSiteToSiteVpnAttachment
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
Inherited Members
Namespace: Amazon.CDK.AWS.NetworkManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSiteToSiteVpnAttachment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSiteToSiteVpnAttachment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::NetworkManager::SiteToSiteVpnAttachment
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.NetworkManager;
var cfnSiteToSiteVpnAttachment = new CfnSiteToSiteVpnAttachment(this, "MyCfnSiteToSiteVpnAttachment", new CfnSiteToSiteVpnAttachmentProps {
CoreNetworkId = "coreNetworkId",
VpnConnectionArn = "vpnConnectionArn",
// the properties below are optional
NetworkFunctionGroupName = "networkFunctionGroupName",
ProposedNetworkFunctionGroupChange = new ProposedNetworkFunctionGroupChangeProperty {
AttachmentPolicyRuleNumber = 123,
NetworkFunctionGroupName = "networkFunctionGroupName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
},
ProposedSegmentChange = new ProposedSegmentChangeProperty {
AttachmentPolicyRuleNumber = 123,
SegmentName = "segmentName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSiteToSiteVpnAttachment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSiteToSiteVpnAttachment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSiteToSiteVpnAttachment(Construct, String, ICfnSiteToSiteVpnAttachmentProps) |
Properties
AttrAttachmentId | The ID of the site-to-site VPN attachment. |
AttrAttachmentPolicyRuleNumber | The policy rule number associated with the attachment. |
AttrAttachmentType | The type of attachment. |
AttrCoreNetworkArn | The ARN of the core network. |
AttrCreatedAt | The timestamp when the site-to-site VPN attachment was created. |
AttrEdgeLocation | The Region where the core network edge is located. |
AttrOwnerAccountId | The ID of the site-to-site VPN attachment owner. |
AttrResourceArn | The resource ARN for the site-to-site VPN attachment. |
AttrSegmentName | The name of the site-to-site VPN attachment's segment. |
AttrState | The state of the site-to-site VPN attachment. |
AttrUpdatedAt | The timestamp when the site-to-site VPN attachment was last updated. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CoreNetworkId | The ID of a core network where you're creating a site-to-site VPN attachment. |
NetworkFunctionGroupName | The name of the network function group. |
ProposedNetworkFunctionGroupChange | Describes proposed changes to a network function group. |
ProposedSegmentChange | Describes a proposed segment change. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags associated with the Site-to-Site VPN attachment. |
VpnConnectionArn | The ARN of the site-to-site VPN attachment. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSiteToSiteVpnAttachment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSiteToSiteVpnAttachment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSiteToSiteVpnAttachment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSiteToSiteVpnAttachment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSiteToSiteVpnAttachment(Construct, String, ICfnSiteToSiteVpnAttachmentProps)
public CfnSiteToSiteVpnAttachment(Construct scope, string id, ICfnSiteToSiteVpnAttachmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSiteToSiteVpnAttachmentProps
Resource properties.
Properties
AttrAttachmentId
The ID of the site-to-site VPN attachment.
public virtual string AttrAttachmentId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AttachmentId
AttrAttachmentPolicyRuleNumber
The policy rule number associated with the attachment.
public virtual double AttrAttachmentPolicyRuleNumber { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: AttachmentPolicyRuleNumber
AttrAttachmentType
The type of attachment.
public virtual string AttrAttachmentType { get; }
Property Value
System.String
Remarks
This will be SITE_TO_SITE_VPN
.
CloudformationAttribute: AttachmentType
AttrCoreNetworkArn
The ARN of the core network.
public virtual string AttrCoreNetworkArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CoreNetworkArn
AttrCreatedAt
The timestamp when the site-to-site VPN attachment was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrEdgeLocation
The Region where the core network edge is located.
public virtual string AttrEdgeLocation { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EdgeLocation
AttrOwnerAccountId
The ID of the site-to-site VPN attachment owner.
public virtual string AttrOwnerAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: OwnerAccountId
AttrResourceArn
The resource ARN for the site-to-site VPN attachment.
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ResourceArn
AttrSegmentName
The name of the site-to-site VPN attachment's segment.
public virtual string AttrSegmentName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SegmentName
AttrState
The state of the site-to-site VPN attachment.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
This can be: REJECTED
| PENDING_ATTACHMENT_ACCEPTANCE
| CREATING
| FAILED
| AVAILABLE
| UPDATING
| PENDING_NETWORK_UPDATE
| PENDING_TAG_ACCEPTANCE
| DELETING
.
CloudformationAttribute: State
AttrUpdatedAt
The timestamp when the site-to-site VPN attachment was last updated.
public virtual string AttrUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdatedAt
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
CoreNetworkId
The ID of a core network where you're creating a site-to-site VPN attachment.
public virtual string CoreNetworkId { get; set; }
Property Value
System.String
NetworkFunctionGroupName
The name of the network function group.
public virtual string NetworkFunctionGroupName { get; set; }
Property Value
System.String
ProposedNetworkFunctionGroupChange
Describes proposed changes to a network function group.
public virtual object ProposedNetworkFunctionGroupChange { get; set; }
Property Value
System.Object
ProposedSegmentChange
Describes a proposed segment change.
public virtual object ProposedSegmentChange { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags associated with the Site-to-Site VPN attachment.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VpnConnectionArn
The ARN of the site-to-site VPN attachment.
public virtual string VpnConnectionArn { get; set; }
Property Value
System.String
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>