Package software.amazon.awscdk.services.networksecuritymanager

Class CfnScope

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.networksecuritymanager.CfnScope
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IScopeRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-10-08T16:59:59.241Z") @Stability(Stable) public class CfnScope extends CfnResource implements IInspectable, IScopeRef, ITaggableV2
Resource Type definition for AWS::NetworkSecurityManager::Scope.

Creates and manages a Network Security Manager scope.

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.networksecuritymanager.*;
 CfnScope cfnScope = CfnScope.Builder.create(this, "MyCfnScope")
         .scopeName("scopeName")
         // the properties below are optional
         .scopeConfiguration("scopeConfiguration")
         .scopeDescription("scopeDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnScope

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

    • CfnScope

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

    • CfnScope

      @Stability(Stable) public CfnScope(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnScopeProps props)
      Create a new AWS::NetworkSecurityManager::Scope.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForScope

      @Stability(Stable) @NotNull public static String arnForScope(@NotNull IScopeRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnScope

      @Stability(Stable) @NotNull public static Boolean isCfnScope(@NotNull Object x)
      Checks whether the given object is a CfnScope.

      Parameters:
      x - This parameter is required.

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

    • getAttrScopeArn

      @Stability(Stable) @NotNull public String getAttrScopeArn()
      The Amazon Resource Name (ARN) of the scope.

    • getAttrScopeId

      @Stability(Stable) @NotNull public String getAttrScopeId()
      The unique identifier of the scope.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the scope.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The version number of the scope.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getScopeRef

      @Stability(Stable) @NotNull public ScopeReference getScopeRef()
      A reference to a Scope resource.
      Specified by:
      getScopeRef in interface IScopeRef

    • getScopeName

      @Stability(Stable) @NotNull public String getScopeName()
      The name of the scope.

    • setScopeName

      @Stability(Stable) public void setScopeName(@NotNull String value)
      The name of the scope.

    • getScopeConfiguration

      @Stability(Stable) @Nullable public String getScopeConfiguration()
      The scope configuration as a JSON string.

    • setScopeConfiguration

      @Stability(Stable) public void setScopeConfiguration(@Nullable String value)
      The scope configuration as a JSON string.

    • getScopeDescription

      @Stability(Stable) @Nullable public String getScopeDescription()
      A description of the scope.

    • setScopeDescription

      @Stability(Stable) public void setScopeDescription(@Nullable String value)
      A description of the scope.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags associated with the scope.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags associated with the scope.