software.amazon.awscdk.services.networkmanager

Class CfnConnectPeer

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.044Z")
 @Stability(value=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")
         .bgpOptions(BgpOptionsProperty.builder()
                 .peerAsn(123)
                 .build())
         .connectAttachmentId("connectAttachmentId")
         .coreNetworkAddress("coreNetworkAddress")
         .insideCidrBlocks(List.of("insideCidrBlocks"))
         .peerAddress("peerAddress")
         .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.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectPeer(software.constructs.Construct scope, String id) Create a new `AWS::NetworkManager::ConnectPeer`.
	CfnConnectPeer(software.constructs.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 and Description
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() The BGP peer options.
protected Map<String,Object>	getCfnProperties()
String	getConnectAttachmentId() The ID of Connect peer.
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 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(CfnConnectPeer.BgpOptionsProperty value) The BGP peer options.
void	setBgpOptions(IResolvable value) The BGP peer options.
void	setConnectAttachmentId(String value) The ID of Connect peer.
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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnConnectPeer(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               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.

CfnConnectPeer

@Stability(value=Stable)
public CfnConnectPeer(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

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.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectPeerId

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

The ID of the Connect peer.

getAttrCoreNetworkId

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

The core network ID.

getAttrCreatedAt

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

The timestamp when the Connect peer was created.

getAttrEdgeLocation

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

The Region where the edge is located.

getAttrState

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags associated with the Connect peer.

getBgpOptions

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

The BGP peer options.

setBgpOptions

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

The BGP peer options.

setBgpOptions

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

The BGP peer options.

getConnectAttachmentId

@Stability(value=Stable)
 @Nullable
public String getConnectAttachmentId()

The ID of Connect peer.

setConnectAttachmentId

@Stability(value=Stable)
public void setConnectAttachmentId(@Nullable
                                                            String value)

The ID of Connect peer.

getCoreNetworkAddress

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

The IP address of a core network.

setCoreNetworkAddress

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

The IP address of a core network.

getInsideCidrBlocks

@Stability(value=Stable)
 @Nullable
public List<String> getInsideCidrBlocks()

The inside IP addresses used for a Connect peer configuration.

setInsideCidrBlocks

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

The inside IP addresses used for a Connect peer configuration.

getPeerAddress

@Stability(value=Stable)
 @Nullable
public String getPeerAddress()

The IP address of the Connect peer.

setPeerAddress

@Stability(value=Stable)
public void setPeerAddress(@Nullable
                                                    String value)

The IP address of the Connect peer.