CfnCoreNetwork

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

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

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

Describes a core 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 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.

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
	`CfnCoreNetwork(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrCoreNetworkArn()` The ARN of the core network.
`java.lang.String`	`getAttrCoreNetworkId()` The ID of the core network.
`java.lang.String`	`getAttrCreatedAt()` The timestamp when the core network was created.
`IResolvable`	`getAttrEdges()` The edges.
`java.lang.String`	`getAttrOwnerAccount()`
`IResolvable`	`getAttrSegments()` The segments.
`java.lang.String`	`getAttrState()` The current state of the core network.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` The description of a core network.
`java.lang.String`	`getGlobalNetworkId()` The ID of the global network that your core network is a part of.
`java.lang.Object`	`getPolicyDocument()` Describes a core network policy.
`TagManager`	`getTags()` The list of key-value tags associated with a core network.
`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`	`setDescription(java.lang.String value)` The description of a core network.
`void`	`setGlobalNetworkId(java.lang.String value)` The ID of the global network that your core network is a part of.
`void`	`setPolicyDocument(java.lang.Object value)` Describes a core network policy.

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
  - CfnCoreNetwork
```
protected CfnCoreNetwork(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnCoreNetwork
```
protected CfnCoreNetwork(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnCoreNetwork
```
public CfnCoreNetwork(Construct scope,
                      java.lang.String id,
                      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
```
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.
  - getAttrCoreNetworkArn
```
public java.lang.String getAttrCoreNetworkArn()
```
    The ARN of the core network.
  - getAttrCoreNetworkId
```
public java.lang.String getAttrCoreNetworkId()
```
    The ID of the core network.
  - getAttrCreatedAt
```
public java.lang.String getAttrCreatedAt()
```
    The timestamp when the core network was created.
  - getAttrEdges
```
public IResolvable getAttrEdges()
```
    The edges.
  - getAttrOwnerAccount
```
public java.lang.String getAttrOwnerAccount()
```
  - getAttrSegments
```
public IResolvable getAttrSegments()
```
    The segments.
  - getAttrState
```
public java.lang.String getAttrState()
```
    The current state of the core network.
    These states are: CREATING | UPDATING | AVAILABLE | 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 a core network.
  - getGlobalNetworkId
```
public java.lang.String getGlobalNetworkId()
```
    The ID of the global network that your core network is a part of.
  - setGlobalNetworkId
```
public void setGlobalNetworkId(java.lang.String value)
```
    The ID of the global network that your core network is a part of.
  - getPolicyDocument
```
public java.lang.Object getPolicyDocument()
```
    Describes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.html) .
    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
```
public void setPolicyDocument(java.lang.Object value)
```
    Describes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.html) .
    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
```
public java.lang.String getDescription()
```
    The description of a core network.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of a core network.

Class CfnCoreNetwork

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCoreNetwork

CfnCoreNetwork

CfnCoreNetwork

Method Detail

inspect

renderProperties

getAttrCoreNetworkArn

getAttrCoreNetworkId

getAttrCreatedAt

getAttrEdges

getAttrOwnerAccount

getAttrSegments

getAttrState

getCfnProperties

getTags

getGlobalNetworkId

setGlobalNetworkId

getPolicyDocument

setPolicyDocument

getDescription

setDescription