Class CfnVpcAttachment
Creates a VPC 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 CfnVpcAttachment : CfnResource, IInspectable, IVpcAttachmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnVpcAttachment Inherits CfnResource Implements IInspectable, IVpcAttachmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
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 cfnVpcAttachment = new CfnVpcAttachment(this, "MyCfnVpcAttachment", new CfnVpcAttachmentProps {
CoreNetworkId = "coreNetworkId",
SubnetArns = new [] { "subnetArns" },
VpcArn = "vpcArn",
// the properties below are optional
Options = new VpcOptionsProperty {
ApplianceModeSupport = false,
DnsSupport = false,
Ipv6Support = false,
SecurityGroupReferencingSupport = false
},
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"
} }
},
RoutingPolicyLabel = "routingPolicyLabel",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnVpcAttachment(Construct, string, ICfnVpcAttachmentProps) | Create a new |
Properties
| AttrAttachmentId | The ID of the VPC 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 VPC attachment was created. |
| AttrEdgeLocation | The Region where the core network edge is located. |
| AttrLastModificationErrors | Errors from the last modification of the attachment. |
| AttrNetworkFunctionGroupName | The name of the network function group. |
| AttrOwnerAccountId | The ID of the VPC attachment owner. |
| AttrResourceArn | The resource ARN for the VPC attachment. |
| AttrSegmentName | The name of the attachment's segment. |
| AttrState | The state of the attachment. |
| AttrUpdatedAt | The timestamp when the VPC attachment was last updated. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Creates a VPC attachment on an edge location of a core network. |
| CfnPropertyNames | Creates a VPC attachment on an edge location of a core network. |
| CoreNetworkId | The core network ID. |
| Options | Options for creating the VPC attachment. |
| ProposedNetworkFunctionGroupChange | Describes proposed changes to a network function group. |
| ProposedSegmentChange | Describes a proposed segment change. |
| RoutingPolicyLabel | Routing policy label. |
| SubnetArns | The subnet ARNs. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | The tags associated with the VPC attachment. |
| VpcArn | The ARN of the VPC attachment. |
| VpcAttachmentRef | A reference to a VpcAttachment resource. |
Methods
| ArnForVpcAttachment(IVpcAttachmentRef) | Creates a VPC attachment on an edge location of a core network. |
| FromAttachmentId(Construct, string, string) | Creates a new IVpcAttachmentRef from a attachmentId. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnVpcAttachment(object) | Checks whether the given object is a CfnVpcAttachment. |
| RenderProperties(IDictionary<string, object>) | Creates a VPC attachment on an edge location of a core network. |
Constructors
CfnVpcAttachment(Construct, string, ICfnVpcAttachmentProps)
Create a new AWS::NetworkManager::VpcAttachment.
public CfnVpcAttachment(Construct scope, string id, ICfnVpcAttachmentProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnVpcAttachmentProps
Resource properties.
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
Properties
AttrAttachmentId
The ID of the VPC attachment.
public virtual string AttrAttachmentId { get; }
Property Value
Remarks
CloudformationAttribute: AttachmentId
AttrAttachmentPolicyRuleNumber
The policy rule number associated with the attachment.
public virtual double AttrAttachmentPolicyRuleNumber { get; }
Property Value
Remarks
CloudformationAttribute: AttachmentPolicyRuleNumber
AttrAttachmentType
The type of attachment.
public virtual string AttrAttachmentType { get; }
Property Value
Remarks
This will be VPC .
CloudformationAttribute: AttachmentType
AttrCoreNetworkArn
The ARN of the core network.
public virtual string AttrCoreNetworkArn { get; }
Property Value
Remarks
CloudformationAttribute: CoreNetworkArn
AttrCreatedAt
The timestamp when the VPC attachment was created.
public virtual string AttrCreatedAt { get; }
Property Value
Remarks
CloudformationAttribute: CreatedAt
AttrEdgeLocation
The Region where the core network edge is located.
public virtual string AttrEdgeLocation { get; }
Property Value
Remarks
CloudformationAttribute: EdgeLocation
AttrLastModificationErrors
Errors from the last modification of the attachment.
public virtual string[] AttrLastModificationErrors { get; }
Property Value
string[]
Remarks
CloudformationAttribute: LastModificationErrors
AttrNetworkFunctionGroupName
The name of the network function group.
public virtual string AttrNetworkFunctionGroupName { get; }
Property Value
Remarks
CloudformationAttribute: NetworkFunctionGroupName
AttrOwnerAccountId
The ID of the VPC attachment owner.
public virtual string AttrOwnerAccountId { get; }
Property Value
Remarks
CloudformationAttribute: OwnerAccountId
AttrResourceArn
The resource ARN for the VPC attachment.
public virtual string AttrResourceArn { get; }
Property Value
Remarks
CloudformationAttribute: ResourceArn
AttrSegmentName
The name of the attachment's segment.
public virtual string AttrSegmentName { get; }
Property Value
Remarks
CloudformationAttribute: SegmentName
AttrState
The state of the attachment.
public virtual string AttrState { get; }
Property Value
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 VPC attachment was last updated.
public virtual string AttrUpdatedAt { get; }
Property Value
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
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
CfnProperties
Creates a VPC attachment on an edge location of a core network.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
CfnPropertyNames
Creates a VPC attachment on an edge location of a core network.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
CoreNetworkId
The core network ID.
public virtual string CoreNetworkId { get; set; }
Property Value
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
Options
Options for creating the VPC attachment.
public virtual object? Options { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnVpcAttachment.IVpcOptionsProperty
ProposedNetworkFunctionGroupChange
Describes proposed changes to a network function group.
public virtual object? ProposedNetworkFunctionGroupChange { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnVpcAttachment.IProposedNetworkFunctionGroupChangeProperty
ProposedSegmentChange
Describes a proposed segment change.
public virtual object? ProposedSegmentChange { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnVpcAttachment.IProposedSegmentChangeProperty
RoutingPolicyLabel
Routing policy label.
public virtual string? RoutingPolicyLabel { get; set; }
Property Value
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
SubnetArns
The subnet ARNs.
public virtual string[] SubnetArns { get; set; }
Property Value
string[]
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
TagsRaw
The tags associated with the VPC attachment.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
VpcArn
The ARN of the VPC attachment.
public virtual string VpcArn { get; set; }
Property Value
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
VpcAttachmentRef
A reference to a VpcAttachment resource.
public virtual IVpcAttachmentReference VpcAttachmentRef { get; }
Property Value
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
Methods
ArnForVpcAttachment(IVpcAttachmentRef)
Creates a VPC attachment on an edge location of a core network.
public static string ArnForVpcAttachment(IVpcAttachmentRef resource)
Parameters
- resource IVpcAttachmentRef
Returns
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
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 cfnVpcAttachment = new CfnVpcAttachment(this, "MyCfnVpcAttachment", new CfnVpcAttachmentProps {
CoreNetworkId = "coreNetworkId",
SubnetArns = new [] { "subnetArns" },
VpcArn = "vpcArn",
// the properties below are optional
Options = new VpcOptionsProperty {
ApplianceModeSupport = false,
DnsSupport = false,
Ipv6Support = false,
SecurityGroupReferencingSupport = false
},
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"
} }
},
RoutingPolicyLabel = "routingPolicyLabel",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
FromAttachmentId(Construct, string, string)
Creates a new IVpcAttachmentRef from a attachmentId.
public static IVpcAttachmentRef FromAttachmentId(Construct scope, string id, string attachmentId)
Parameters
Returns
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
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
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
IsCfnVpcAttachment(object)
Checks whether the given object is a CfnVpcAttachment.
public static bool IsCfnVpcAttachment(object x)
Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a VPC attachment on an edge location of a core network.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::NetworkManager::VpcAttachment
ExampleMetadata: fixture=_generated