Package software.amazon.awscdk.services.networkmanager

Class CfnConnectPeer

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:00.449Z")
@Stability(Stable)
public class CfnConnectPeer
extends CfnResource
implements IInspectable

A CloudFormation AWS::NetworkManager::ConnectPeer.

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

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.*;
 CfnConnectPeer cfnConnectPeer = CfnConnectPeer.Builder.create(this, "MyCfnConnectPeer")
         .connectAttachmentId("connectAttachmentId")
         .insideCidrBlocks(List.of("insideCidrBlocks"))
         .peerAddress("peerAddress")
         // the properties below are optional
         .bgpOptions(BgpOptionsProperty.builder()
                 .peerAsn(123)
                 .build())
         .coreNetworkAddress("coreNetworkAddress")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConnectPeer.BgpOptionsProperty	Describes the BGP options.
static final class	CfnConnectPeer.Builder	A fluent builder for CfnConnectPeer.
static interface	CfnConnectPeer.ConnectPeerBgpConfigurationProperty	Describes a core network BGP configuration.
static interface	CfnConnectPeer.ConnectPeerConfigurationProperty	Describes a core network Connect peer configuration.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.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
	CfnConnectPeer(Construct scope, String id, CfnConnectPeerProps props)	Create a new AWS::NetworkManager::ConnectPeer.
protected	CfnConnectPeer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectPeer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
IResolvable	getAttrConfigurationBgpConfigurations()
String	getAttrConfigurationCoreNetworkAddress()
List<String>	getAttrConfigurationInsideCidrBlocks()
String	getAttrConfigurationPeerAddress()
String	getAttrConfigurationProtocol()
String	getAttrConnectPeerId()	The ID of the Connect peer.
String	getAttrCoreNetworkId()	The core network ID.
String	getAttrCreatedAt()	The timestamp when the Connect peer was created.
String	getAttrEdgeLocation()	The Region where the edge is located.
String	getAttrState()	The state of the Connect peer.
Object	getBgpOptions()	AWS::NetworkManager::ConnectPeer.BgpOptions.
protected Map<String,Object>	getCfnProperties()
String	getConnectAttachmentId()	The ID of the attachment to connect.
String	getCoreNetworkAddress()	The IP address of a core network.
List<String>	getInsideCidrBlocks()	The inside IP addresses used for a Connect peer configuration.
String	getPeerAddress()	The IP address of the Connect peer.
TagManager	getTags()	The list of key-value tags associated with the Connect peer.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBgpOptions(IResolvable value)	AWS::NetworkManager::ConnectPeer.BgpOptions.
void	setBgpOptions(CfnConnectPeer.BgpOptionsProperty value)	AWS::NetworkManager::ConnectPeer.BgpOptions.
void	setConnectAttachmentId(String value)	The ID of the attachment to connect.
void	setCoreNetworkAddress(String value)	The IP address of a core network.
void	setInsideCidrBlocks(List<String> value)	The inside IP addresses used for a Connect peer configuration.
void	setPeerAddress(String value)	The IP address of the Connect peer.

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

CfnConnectPeer

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

CfnConnectPeer

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

CfnConnectPeer

@Stability(Stable)
public CfnConnectPeer(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnConnectPeerProps props)

Create a new AWS::NetworkManager::ConnectPeer.

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

getAttrConfigurationBgpConfigurations

@Stability(Stable)
@NotNull
public IResolvable getAttrConfigurationBgpConfigurations()

getAttrConfigurationCoreNetworkAddress

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

getAttrConfigurationInsideCidrBlocks

@Stability(Stable)
@NotNull
public List<String> getAttrConfigurationInsideCidrBlocks()

getAttrConfigurationPeerAddress

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

getAttrConfigurationProtocol

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

getAttrConnectPeerId

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

The ID of the Connect peer.

getAttrCoreNetworkId

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

The core network ID.

getAttrCreatedAt

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

The timestamp when the Connect peer was created.

getAttrEdgeLocation

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

The Region where the edge is located.

getAttrState

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

The state of the Connect peer.

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The list of key-value tags associated with the Connect peer.

getConnectAttachmentId

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

The ID of the attachment to connect.

setConnectAttachmentId

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

The ID of the attachment to connect.

getInsideCidrBlocks

@Stability(Stable)
@NotNull
public List<String> getInsideCidrBlocks()

The inside IP addresses used for a Connect peer configuration.

setInsideCidrBlocks

@Stability(Stable)
public void setInsideCidrBlocks(@NotNull
 List<String> value)

The inside IP addresses used for a Connect peer configuration.

getPeerAddress

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

The IP address of the Connect peer.

setPeerAddress

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

The IP address of the Connect peer.

getBgpOptions

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

AWS::NetworkManager::ConnectPeer.BgpOptions.

setBgpOptions

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

AWS::NetworkManager::ConnectPeer.BgpOptions.

setBgpOptions

@Stability(Stable)
public void setBgpOptions(@Nullable
 CfnConnectPeer.BgpOptionsProperty value)

AWS::NetworkManager::ConnectPeer.BgpOptions.

getCoreNetworkAddress

@Stability(Stable)
@Nullable
public String getCoreNetworkAddress()

The IP address of a core network.

setCoreNetworkAddress

@Stability(Stable)
public void setCoreNetworkAddress(@Nullable
 String value)

The IP address of a core network.