software.amazon.awscdk.services.networkmanager

Class CfnCoreNetwork

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

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.045Z")
 @Stability(value=Stable)
public class CfnCoreNetwork
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::CoreNetwork`.

Describes a core network within a global 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.*;
 Object policyDocument;
 CfnCoreNetwork cfnCoreNetwork = CfnCoreNetwork.Builder.create(this, "MyCfnCoreNetwork")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .description("description")
         .policyDocument(policyDocument)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCoreNetwork.Builder A fluent builder for CfnCoreNetwork.
static interface	CfnCoreNetwork.CoreNetworkEdgeProperty Describes a core network edge.
static interface	CfnCoreNetwork.CoreNetworkSegmentProperty Describes a core network segment, which are dedicated routes.

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
	CfnCoreNetwork(software.constructs.Construct scope, String id, CfnCoreNetworkProps props) Create a new `AWS::NetworkManager::CoreNetwork`.
protected	CfnCoreNetwork(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCoreNetwork(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCoreNetworkArn() The ARN of the core network.
String	getAttrCoreNetworkId() The core network ID.
String	getAttrCreatedAt() The timestamp when the core network was created.
IResolvable	getAttrEdges()
String	getAttrOwnerAccount()
IResolvable	getAttrSegments()
String	getAttrState() The current state of the core network.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of a core network.
String	getGlobalNetworkId() The ID of the global network that your core network is a part of.
Object	getPolicyDocument() Describes a core network policy.
TagManager	getTags() The tags associated with a core network.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of a core network.
void	setGlobalNetworkId(String value) The ID of the global network that your core network is a part of.
void	setPolicyDocument(Object value) Describes a core network policy.

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

CfnCoreNetwork

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

CfnCoreNetwork

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

CfnCoreNetwork

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

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

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

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

getAttrCoreNetworkArn

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

The ARN of the core network.

getAttrCoreNetworkId

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

The core network ID.

getAttrCreatedAt

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

The timestamp when the core network was created.

getAttrEdges

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrEdges()

getAttrOwnerAccount

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

getAttrSegments

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrSegments()

getAttrState

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

The current state of the core network.

These states are: CREATING | UPDATING | AVAILABLE | 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 a core network.

getGlobalNetworkId

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

The ID of the global network that your core network is a part of.

setGlobalNetworkId

@Stability(value=Stable)
public void setGlobalNetworkId(@NotNull
                                                        String value)

The ID of the global network that your core network is a part of.

getPolicyDocument

@Stability(value=Stable)
 @NotNull
public Object getPolicyDocument()

Describes a core network policy.

If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy.

setPolicyDocument

@Stability(value=Stable)
public void setPolicyDocument(@NotNull
                                                       Object value)

Describes a core network policy.

If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy.

getDescription

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

The description of a core network.

setDescription

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

The description of a core network.