Package software.amazon.awscdk.services.networkmanager

Class CfnSiteToSiteVpnAttachment

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-23T02:06:35.470Z")
@Stability(Stable)
public class CfnSiteToSiteVpnAttachment
extends CfnResource
implements IInspectable, ITaggable

Creates an Amazon Web Services site-to-site VPN 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.*;
 CfnSiteToSiteVpnAttachment cfnSiteToSiteVpnAttachment = CfnSiteToSiteVpnAttachment.Builder.create(this, "MyCfnSiteToSiteVpnAttachment")
         .coreNetworkId("coreNetworkId")
         .vpnConnectionArn("vpnConnectionArn")
         // the properties below are optional
         .proposedSegmentChange(ProposedSegmentChangeProperty.builder()
                 .attachmentPolicyRuleNumber(123)
                 .segmentName("segmentName")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSiteToSiteVpnAttachment.Builder	A fluent builder for CfnSiteToSiteVpnAttachment.
static interface	CfnSiteToSiteVpnAttachment.ProposedSegmentChangeProperty	Describes a proposed segment change.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSiteToSiteVpnAttachment(software.constructs.Construct scope, String id, CfnSiteToSiteVpnAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAttachmentId()	The ID of the site-to-site VPN 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 site-to-site VPN attachment was created.
String	getAttrEdgeLocation()	The Region where the core network edge is located.
String	getAttrOwnerAccountId()	The ID of the site-to-site VPN attachment owner.
String	getAttrResourceArn()	The resource ARN for the site-to-site VPN attachment.
String	getAttrSegmentName()	The name of the site-to-site VPN attachment's segment.
String	getAttrState()	The state of the site-to-site VPN attachment.
String	getAttrUpdatedAt()	The timestamp when the site-to-site VPN attachment was last updated.
protected Map<String,Object>	getCfnProperties()
String	getCoreNetworkId()	The ID of a core network where you're creating a site-to-site VPN attachment.
Object	getProposedSegmentChange()	Describes a proposed segment change.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Tags for the attachment.
String	getVpnConnectionArn()	The ARN of the site-to-site VPN 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 ID of a core network where you're creating a site-to-site VPN attachment.
void	setProposedSegmentChange(IResolvable value)	Describes a proposed segment change.
void	setProposedSegmentChange(CfnSiteToSiteVpnAttachment.ProposedSegmentChangeProperty value)	Describes a proposed segment change.
void	setTagsRaw(List<CfnTag> value)	Tags for the attachment.
void	setVpnConnectionArn(String value)	The ARN of the site-to-site VPN attachment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSiteToSiteVpnAttachment

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

CfnSiteToSiteVpnAttachment

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

CfnSiteToSiteVpnAttachment

@Stability(Stable)
public CfnSiteToSiteVpnAttachment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSiteToSiteVpnAttachmentProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrAttachmentId()

The ID of the site-to-site VPN attachment.

getAttrAttachmentPolicyRuleNumber

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

The policy rule number associated with the attachment.

getAttrAttachmentType

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

The type of attachment.

This will be SITE_TO_SITE_VPN .

getAttrCoreNetworkArn

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

The ARN of the core network.

getAttrCreatedAt

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

The timestamp when the site-to-site VPN attachment was created.

getAttrEdgeLocation

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

The Region where the core network edge is located.

getAttrOwnerAccountId

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

The ID of the site-to-site VPN attachment owner.

getAttrResourceArn

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

The resource ARN for the site-to-site VPN attachment.

getAttrSegmentName

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

The name of the site-to-site VPN attachment's segment.

getAttrState

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

The state of the site-to-site VPN attachment.

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

getAttrUpdatedAt

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

The timestamp when the site-to-site VPN attachment was last updated.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getCoreNetworkId

@Stability(Stable)
@NotNull
public String getCoreNetworkId()

The ID of a core network where you're creating a site-to-site VPN attachment.

setCoreNetworkId

@Stability(Stable)
public void setCoreNetworkId(@NotNull
 String value)

The ID of a core network where you're creating a site-to-site VPN attachment.

getVpnConnectionArn

@Stability(Stable)
@NotNull
public String getVpnConnectionArn()

The ARN of the site-to-site VPN attachment.

setVpnConnectionArn

@Stability(Stable)
public void setVpnConnectionArn(@NotNull
 String value)

The ARN of the site-to-site VPN attachment.

getProposedSegmentChange

@Stability(Stable)
@Nullable
public Object getProposedSegmentChange()

Describes a proposed segment change.

setProposedSegmentChange

@Stability(Stable)
public void setProposedSegmentChange(@Nullable
 IResolvable value)

Describes a proposed segment change.

setProposedSegmentChange

@Stability(Stable)
public void setProposedSegmentChange(@Nullable
 CfnSiteToSiteVpnAttachment.ProposedSegmentChangeProperty value)

Describes a proposed segment change.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Tags for the attachment.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Tags for the attachment.