software.amazon.awscdk.services.networkmanager

Class CfnSiteToSiteVpnAttachment

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.networkmanager.CfnSiteToSiteVpnAttachment

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.940Z")
public class CfnSiteToSiteVpnAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::SiteToSiteVpnAttachment`.

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
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSiteToSiteVpnAttachment(Construct scope, java.lang.String id, CfnSiteToSiteVpnAttachmentProps props) Create a new `AWS::NetworkManager::SiteToSiteVpnAttachment`.
protected	CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAttachmentId() The ID of the site-to-site VPN attachment.
java.lang.Number	getAttrAttachmentPolicyRuleNumber() The policy rule number associated with the attachment.
java.lang.String	getAttrAttachmentType() The type of attachment.
java.lang.String	getAttrCoreNetworkArn() The ARN of the core network.
java.lang.String	getAttrCreatedAt() The timestamp when the site-to-site VPN attachment was created.
java.lang.String	getAttrEdgeLocation() The Region where the core network edge is located.
java.lang.String	getAttrOwnerAccountId() The ID of the site-to-site VPN attachment owner.
java.lang.Number	getAttrProposedSegmentChangeAttachmentPolicyRuleNumber()
java.lang.String	getAttrProposedSegmentChangeSegmentName()
IResolvable	getAttrProposedSegmentChangeTags()
java.lang.String	getAttrResourceArn() The resource ARN for the site-to-site VPN attachment.
java.lang.String	getAttrSegmentName() The name of the site-to-site VPN attachment's segment.
java.lang.String	getAttrState() The state of the site-to-site VPN attachment.
java.lang.String	getAttrUpdatedAt() The timestamp when the site-to-site VPN attachment was last updated.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCoreNetworkId() `AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`.
TagManager	getTags() `AWS::NetworkManager::SiteToSiteVpnAttachment.Tags`.
java.lang.String	getVpnConnectionArn() The ARN of the site-to-site VPN attachment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCoreNetworkId(java.lang.String value) `AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`.
void	setVpnConnectionArn(java.lang.String value) The ARN of the site-to-site VPN attachment.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSiteToSiteVpnAttachment

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

CfnSiteToSiteVpnAttachment

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

CfnSiteToSiteVpnAttachment

public CfnSiteToSiteVpnAttachment(Construct scope,
                                  java.lang.String id,
                                  CfnSiteToSiteVpnAttachmentProps props)

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

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. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAttachmentId

public java.lang.String getAttrAttachmentId()

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

getAttrAttachmentPolicyRuleNumber

public java.lang.Number getAttrAttachmentPolicyRuleNumber()

The policy rule number associated with the attachment.

getAttrAttachmentType

public java.lang.String getAttrAttachmentType()

The type of attachment.

This will be SITE_TO_SITE_VPN .

getAttrCoreNetworkArn

public java.lang.String getAttrCoreNetworkArn()

The ARN of the core network.

getAttrCreatedAt

public java.lang.String getAttrCreatedAt()

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

getAttrEdgeLocation

public java.lang.String getAttrEdgeLocation()

The Region where the core network edge is located.

getAttrOwnerAccountId

public java.lang.String getAttrOwnerAccountId()

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

getAttrProposedSegmentChangeAttachmentPolicyRuleNumber

public java.lang.Number getAttrProposedSegmentChangeAttachmentPolicyRuleNumber()

getAttrProposedSegmentChangeSegmentName

public java.lang.String getAttrProposedSegmentChangeSegmentName()

getAttrProposedSegmentChangeTags

public IResolvable getAttrProposedSegmentChangeTags()

getAttrResourceArn

public java.lang.String getAttrResourceArn()

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

getAttrSegmentName

public java.lang.String getAttrSegmentName()

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

getAttrState

public java.lang.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

public java.lang.String getAttrUpdatedAt()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::NetworkManager::SiteToSiteVpnAttachment.Tags`.

getCoreNetworkId

public java.lang.String getCoreNetworkId()

`AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`.

setCoreNetworkId

public void setCoreNetworkId(java.lang.String value)

`AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`.

getVpnConnectionArn

public java.lang.String getVpnConnectionArn()

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

setVpnConnectionArn

public void setVpnConnectionArn(java.lang.String value)

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