software.amazon.awscdk.services.networkmanager

Class CfnConnectAttachment

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

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

A CloudFormation `AWS::NetworkManager::ConnectAttachment`.

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

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.*;
 CfnConnectAttachment cfnConnectAttachment = CfnConnectAttachment.Builder.create(this, "MyCfnConnectAttachment")
         .coreNetworkId("coreNetworkId")
         .edgeLocation("edgeLocation")
         .options(ConnectAttachmentOptionsProperty.builder()
                 .protocol("protocol")
                 .build())
         .transportAttachmentId("transportAttachmentId")
         // 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	CfnConnectAttachment.Builder A fluent builder for CfnConnectAttachment.
static interface	CfnConnectAttachment.ConnectAttachmentOptionsProperty Describes a core network Connect attachment options.
static interface	CfnConnectAttachment.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
	CfnConnectAttachment(Construct scope, java.lang.String id, CfnConnectAttachmentProps props) Create a new `AWS::NetworkManager::ConnectAttachment`.
protected	CfnConnectAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAttachmentId() The ID of the Connect attachment.
java.lang.Number	getAttrAttachmentPolicyRuleNumber() The 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 Connect attachment was created.
java.lang.String	getAttrOwnerAccountId() The ID of the Connect attachment owner.
java.lang.Number	getAttrProposedSegmentChangeAttachmentPolicyRuleNumber()
java.lang.String	getAttrProposedSegmentChangeSegmentName()
IResolvable	getAttrProposedSegmentChangeTags()
java.lang.String	getAttrResourceArn() The resource ARN for the Connect attachment.
java.lang.String	getAttrSegmentName() The name of the Connect attachment's segment.
java.lang.String	getAttrState() The state of the Connect attachment.
java.lang.String	getAttrUpdatedAt() The timestamp when the Connect attachment was last updated.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCoreNetworkId() The ID of the core network where the Connect attachment is located.
java.lang.String	getEdgeLocation() The Region where the edge is located.
java.lang.Object	getOptions() Options for connecting an attachment.
TagManager	getTags() `AWS::NetworkManager::ConnectAttachment.Tags`.
java.lang.String	getTransportAttachmentId() The ID of the transport 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) The ID of the core network where the Connect attachment is located.
void	setEdgeLocation(java.lang.String value) The Region where the edge is located.
void	setOptions(CfnConnectAttachment.ConnectAttachmentOptionsProperty value) Options for connecting an attachment.
void	setOptions(IResolvable value) Options for connecting an attachment.
void	setTransportAttachmentId(java.lang.String value) The ID of the transport 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

CfnConnectAttachment

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

CfnConnectAttachment

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

CfnConnectAttachment

public CfnConnectAttachment(Construct scope,
                            java.lang.String id,
                            CfnConnectAttachmentProps props)

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

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 Connect attachment.

getAttrAttachmentPolicyRuleNumber

public java.lang.Number getAttrAttachmentPolicyRuleNumber()

The rule number associated with the attachment.

getAttrAttachmentType

public java.lang.String getAttrAttachmentType()

The type of attachment.

This will be CONNECT .

getAttrCoreNetworkArn

public java.lang.String getAttrCoreNetworkArn()

The ARN of the core network.

getAttrCreatedAt

public java.lang.String getAttrCreatedAt()

The timestamp when the Connect attachment was created.

getAttrOwnerAccountId

public java.lang.String getAttrOwnerAccountId()

The ID of the Connect 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 Connect attachment.

getAttrSegmentName

public java.lang.String getAttrSegmentName()

The name of the Connect attachment's segment.

getAttrState

public java.lang.String getAttrState()

The state of the Connect 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 Connect 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::ConnectAttachment.Tags`.

getCoreNetworkId

public java.lang.String getCoreNetworkId()

The ID of the core network where the Connect attachment is located.

setCoreNetworkId

public void setCoreNetworkId(java.lang.String value)

The ID of the core network where the Connect attachment is located.

getEdgeLocation

public java.lang.String getEdgeLocation()

The Region where the edge is located.

setEdgeLocation

public void setEdgeLocation(java.lang.String value)

The Region where the edge is located.

getOptions

public java.lang.Object getOptions()

Options for connecting an attachment.

setOptions

public void setOptions(CfnConnectAttachment.ConnectAttachmentOptionsProperty value)

Options for connecting an attachment.

setOptions

public void setOptions(IResolvable value)

Options for connecting an attachment.

getTransportAttachmentId

public java.lang.String getTransportAttachmentId()

The ID of the transport attachment.

setTransportAttachmentId

public void setTransportAttachmentId(java.lang.String value)

The ID of the transport attachment.