software.amazon.awscdk.services.networkmanager

Class CfnConnectPeer

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.551Z")
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 and Description
static interface	CfnConnectPeer.BgpOptionsProperty Describes the BGP options.
static 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 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
	CfnConnectPeer(Construct scope, java.lang.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 and Description
IResolvable	getAttrConfigurationBgpConfigurations()
java.lang.String	getAttrConfigurationCoreNetworkAddress()
java.util.List<java.lang.String>	getAttrConfigurationInsideCidrBlocks()
java.lang.String	getAttrConfigurationPeerAddress()
java.lang.String	getAttrConfigurationProtocol()
java.lang.String	getAttrConnectPeerId() The ID of the Connect peer.
java.lang.String	getAttrCoreNetworkId() The core network ID.
java.lang.String	getAttrCreatedAt() The timestamp when the Connect peer was created.
java.lang.String	getAttrEdgeLocation() The Region where the edge is located.
java.lang.String	getAttrState() The state of the Connect peer.
java.lang.Object	getBgpOptions() `AWS::NetworkManager::ConnectPeer.BgpOptions`.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConnectAttachmentId() The ID of the attachment to connect.
java.lang.String	getCoreNetworkAddress() The IP address of a core network.
java.util.List<java.lang.String>	getInsideCidrBlocks() The inside IP addresses used for a Connect peer configuration.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setBgpOptions(CfnConnectPeer.BgpOptionsProperty value) `AWS::NetworkManager::ConnectPeer.BgpOptions`.
void	setBgpOptions(IResolvable value) `AWS::NetworkManager::ConnectPeer.BgpOptions`.
void	setConnectAttachmentId(java.lang.String value) The ID of the attachment to connect.
void	setCoreNetworkAddress(java.lang.String value) The IP address of a core network.
void	setInsideCidrBlocks(java.util.List<java.lang.String> value) The inside IP addresses used for a Connect peer configuration.
void	setPeerAddress(java.lang.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 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

CfnConnectPeer

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

CfnConnectPeer

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

CfnConnectPeer

public CfnConnectPeer(Construct scope,
                      java.lang.String id,
                      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 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.

getAttrConfigurationBgpConfigurations

public IResolvable getAttrConfigurationBgpConfigurations()

getAttrConfigurationCoreNetworkAddress

public java.lang.String getAttrConfigurationCoreNetworkAddress()

getAttrConfigurationInsideCidrBlocks

public java.util.List<java.lang.String> getAttrConfigurationInsideCidrBlocks()

getAttrConfigurationPeerAddress

public java.lang.String getAttrConfigurationPeerAddress()

getAttrConfigurationProtocol

public java.lang.String getAttrConfigurationProtocol()

getAttrConnectPeerId

public java.lang.String getAttrConnectPeerId()

The ID of the Connect peer.

getAttrCoreNetworkId

public java.lang.String getAttrCoreNetworkId()

The core network ID.

getAttrCreatedAt

public java.lang.String getAttrCreatedAt()

The timestamp when the Connect peer was created.

getAttrEdgeLocation

public java.lang.String getAttrEdgeLocation()

The Region where the edge is located.

getAttrState

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

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getConnectAttachmentId

public java.lang.String getConnectAttachmentId()

The ID of the attachment to connect.

setConnectAttachmentId

public void setConnectAttachmentId(java.lang.String value)

The ID of the attachment to connect.

getInsideCidrBlocks

public java.util.List<java.lang.String> getInsideCidrBlocks()

The inside IP addresses used for a Connect peer configuration.

setInsideCidrBlocks

public void setInsideCidrBlocks(java.util.List<java.lang.String> value)

The inside IP addresses used for a Connect peer configuration.

getPeerAddress

public java.lang.String getPeerAddress()

The IP address of the Connect peer.

setPeerAddress

public void setPeerAddress(java.lang.String value)

The IP address of the Connect peer.

getBgpOptions

public java.lang.Object getBgpOptions()

`AWS::NetworkManager::ConnectPeer.BgpOptions`.

setBgpOptions

public void setBgpOptions(IResolvable value)

`AWS::NetworkManager::ConnectPeer.BgpOptions`.

setBgpOptions

public void setBgpOptions(CfnConnectPeer.BgpOptionsProperty value)

`AWS::NetworkManager::ConnectPeer.BgpOptions`.

getCoreNetworkAddress

public java.lang.String getCoreNetworkAddress()

The IP address of a core network.

setCoreNetworkAddress

public void setCoreNetworkAddress(java.lang.String value)

The IP address of a core network.