software.amazon.awscdk.services.networkmanager

Class CfnVpcAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.networkmanager.CfnVpcAttachment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.066Z")
 @Stability(value=Stable)
public class CfnVpcAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::VpcAttachment`.

Creates a VPC attachment on an edge location of a core network.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkmanager.*;
 CfnVpcAttachment cfnVpcAttachment = CfnVpcAttachment.Builder.create(this, "MyCfnVpcAttachment")
         .coreNetworkId("coreNetworkId")
         .options(VpcOptionsProperty.builder()
                 .ipv6Support(false)
                 .build())
         .subnetArns(List.of("subnetArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcArn("vpcArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVpcAttachment.Builder A fluent builder for CfnVpcAttachment.
static interface	CfnVpcAttachment.VpcOptionsProperty Describes the VPC options.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVpcAttachment(software.constructs.Construct scope, String id) Create a new `AWS::NetworkManager::VpcAttachment`.
	CfnVpcAttachment(software.constructs.Construct scope, String id, CfnVpcAttachmentProps props) Create a new `AWS::NetworkManager::VpcAttachment`.
protected	CfnVpcAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAttachmentId() The ID of the VPC attachment.
Number	getAttrAttachmentPolicyRuleNumber() The policy rule number associated with the attachment.
String	getAttrAttachmentType() The type of attachment.
String	getAttrCoreNetworkArn() The ARN of the core network.
String	getAttrCreatedAt() The timestamp when the VPC attachment was created.
String	getAttrEdgeLocation() The Region where the core network edge is located.
String	getAttrOwnerAccountId() The ID of the VPC attachment owner.
String	getAttrResourceArn() The resource ARN for the VPC attachment.
String	getAttrSegmentName() The name of the attachment's segment.
String	getAttrState() The state of the attachment.
String	getAttrUpdatedAt() The timestamp when the VPC attachment was last updated.
protected Map<String,Object>	getCfnProperties()
String	getCoreNetworkId() The core network ID.
Object	getOptions() Options for creating the VPC attachment.
List<String>	getSubnetArns() The subnet ARNs.
TagManager	getTags() The tags associated with the VPC attachment.
String	getVpcArn() The ARN of the VPC attachment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCoreNetworkId(String value) The core network ID.
void	setOptions(CfnVpcAttachment.VpcOptionsProperty value) Options for creating the VPC attachment.
void	setOptions(IResolvable value) Options for creating the VPC attachment.
void	setSubnetArns(List<String> value) The subnet ARNs.
void	setVpcArn(String value) The ARN of the VPC attachment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVpcAttachment

protected CfnVpcAttachment(software.amazon.jsii.JsiiObjectRef objRef)

CfnVpcAttachment

protected CfnVpcAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVpcAttachment

@Stability(value=Stable)
public CfnVpcAttachment(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @Nullable
                                                 CfnVpcAttachmentProps props)

Create a new `AWS::NetworkManager::VpcAttachment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnVpcAttachment

@Stability(value=Stable)
public CfnVpcAttachment(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id)

Create a new `AWS::NetworkManager::VpcAttachment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAttachmentId

@Stability(value=Stable)
 @NotNull
public String getAttrAttachmentId()

The ID of the VPC attachment.

getAttrAttachmentPolicyRuleNumber

@Stability(value=Stable)
 @NotNull
public Number getAttrAttachmentPolicyRuleNumber()

The policy rule number associated with the attachment.

getAttrAttachmentType

@Stability(value=Stable)
 @NotNull
public String getAttrAttachmentType()

The type of attachment.

This will be VPC .

getAttrCoreNetworkArn

@Stability(value=Stable)
 @NotNull
public String getAttrCoreNetworkArn()

The ARN of the core network.

getAttrCreatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The timestamp when the VPC attachment was created.

getAttrEdgeLocation

@Stability(value=Stable)
 @NotNull
public String getAttrEdgeLocation()

The Region where the core network edge is located.

getAttrOwnerAccountId

@Stability(value=Stable)
 @NotNull
public String getAttrOwnerAccountId()

The ID of the VPC attachment owner.

getAttrResourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrResourceArn()

The resource ARN for the VPC attachment.

getAttrSegmentName

@Stability(value=Stable)
 @NotNull
public String getAttrSegmentName()

The name of the attachment's segment.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The state of the attachment.

This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING .

getAttrUpdatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrUpdatedAt()

The timestamp when the VPC attachment was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags associated with the VPC attachment.

getCoreNetworkId

@Stability(value=Stable)
 @Nullable
public String getCoreNetworkId()

The core network ID.

setCoreNetworkId

@Stability(value=Stable)
public void setCoreNetworkId(@Nullable
                                                      String value)

The core network ID.

getOptions

@Stability(value=Stable)
 @Nullable
public Object getOptions()

Options for creating the VPC attachment.

setOptions

@Stability(value=Stable)
public void setOptions(@Nullable
                                                CfnVpcAttachment.VpcOptionsProperty value)

Options for creating the VPC attachment.

setOptions

@Stability(value=Stable)
public void setOptions(@Nullable
                                                IResolvable value)

Options for creating the VPC attachment.

getSubnetArns

@Stability(value=Stable)
 @Nullable
public List<String> getSubnetArns()

The subnet ARNs.

setSubnetArns

@Stability(value=Stable)
public void setSubnetArns(@Nullable
                                                   List<String> value)

The subnet ARNs.

getVpcArn

@Stability(value=Stable)
 @Nullable
public String getVpcArn()

The ARN of the VPC attachment.

setVpcArn

@Stability(value=Stable)
public void setVpcArn(@Nullable
                                               String value)

The ARN of the VPC attachment.