Package software.amazon.awscdk.services.networkmanager

Class CfnCoreNetwork

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.CfnCoreNetwork
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.452Z") @Stability(Stable) 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();

  • 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

    • CfnCoreNetwork

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

    • CfnCoreNetwork

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

    • CfnCoreNetwork

      @Stability(Stable) public CfnCoreNetwork(@NotNull 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 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.

    • getAttrCoreNetworkArn

      @Stability(Stable) @NotNull public String getAttrCoreNetworkArn()
      The ARN of the core network.

    • getAttrCoreNetworkId

      @Stability(Stable) @NotNull public String getAttrCoreNetworkId()
      The ID of the core network.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the core network was created.

    • getAttrEdges

      @Stability(Stable) @NotNull public IResolvable getAttrEdges()
      The edges.

    • getAttrOwnerAccount

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

    • getAttrSegments

      @Stability(Stable) @NotNull public IResolvable getAttrSegments()
      The segments.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The current state of the core network.

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

    • getGlobalNetworkId

      @Stability(Stable) @NotNull public String getGlobalNetworkId()
      The ID of the global network that your core network is a part of.

    • setGlobalNetworkId

      @Stability(Stable) public void setGlobalNetworkId(@NotNull String value)
      The ID of the global network that your core network is a part of.

    • getPolicyDocument

      @Stability(Stable) @NotNull public Object getPolicyDocument()
      Describes a core network policy. For more information, see Core network policies .

      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(Stable) public void setPolicyDocument(@NotNull Object value)
      Describes a core network policy. For more information, see Core network policies .

      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(Stable) @Nullable public String getDescription()
      The description of a core network.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of a core network.