Package software.amazon.awscdk.services.networksecuritymanager

Class CfnDeployment

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.CfnDeployment
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDeploymentRef, 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.237Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable, IDeploymentRef, ITaggableV2
Resource Type definition for AWS::NetworkSecurityManager::Deployment.

Creates and manages a Network Security Manager deployment.

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.*;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .deploymentName("deploymentName")
         // the properties below are optional
         .associatedPolicyList(List.of(AssociatedPolicyProperty.builder()
                 .policyArn("policyArn")
                 .build()))
         .associatedScopeList(List.of(AssociatedScopeProperty.builder()
                 .scopeArn("scopeArn")
                 .build()))
         .deploymentConfiguration(DeploymentConfigurationProperty.builder()
                 .enableCrossAccountVisibility(false)
                 .build())
         .deploymentDescription("deploymentDescription")
         .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

    • CfnDeployment

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

    • CfnDeployment

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

    • CfnDeployment

      @Stability(Stable) public CfnDeployment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeploymentProps props)
      Create a new AWS::NetworkSecurityManager::Deployment.

      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

    • arnForDeployment

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

    • isCfnDeployment

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

      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.

    • getAttrDeploymentArn

      @Stability(Stable) @NotNull public String getAttrDeploymentArn()
      The ARN of the deployment.

    • getAttrDeploymentId

      @Stability(Stable) @NotNull public String getAttrDeploymentId()
      The unique identifier of the deployment.

    • getAttrStatus

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

    • getAttrVersion

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

    • 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

    • getDeploymentRef

      @Stability(Stable) @NotNull public DeploymentReference getDeploymentRef()
      A reference to a Deployment resource.
      Specified by:
      getDeploymentRef in interface IDeploymentRef

    • getDeploymentName

      @Stability(Stable) @NotNull public String getDeploymentName()
      The name of the deployment.

    • setDeploymentName

      @Stability(Stable) public void setDeploymentName(@NotNull String value)
      The name of the deployment.

    • getAssociatedPolicyList

      @Stability(Stable) @Nullable public Object getAssociatedPolicyList()
      List of policies associated with this deployment.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeployment.AssociatedPolicyProperty>

    • setAssociatedPolicyList

      @Stability(Stable) public void setAssociatedPolicyList(@Nullable IResolvable value)
      List of policies associated with this deployment.

    • setAssociatedPolicyList

      @Stability(Stable) public void setAssociatedPolicyList(@Nullable List<Object> value)
      List of policies associated with this deployment.

    • getAssociatedScopeList

      @Stability(Stable) @Nullable public Object getAssociatedScopeList()
      List of scopes associated with this deployment.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeployment.AssociatedScopeProperty>

    • setAssociatedScopeList

      @Stability(Stable) public void setAssociatedScopeList(@Nullable IResolvable value)
      List of scopes associated with this deployment.

    • setAssociatedScopeList

      @Stability(Stable) public void setAssociatedScopeList(@Nullable List<Object> value)
      List of scopes associated with this deployment.

    • getDeploymentConfiguration

      @Stability(Stable) @Nullable public Object getDeploymentConfiguration()
      Configuration settings for the deployment.

      Returns union: either IResolvable or CfnDeployment.DeploymentConfigurationProperty

    • setDeploymentConfiguration

      @Stability(Stable) public void setDeploymentConfiguration(@Nullable IResolvable value)
      Configuration settings for the deployment.

    • setDeploymentConfiguration

      @Stability(Stable) public void setDeploymentConfiguration(@Nullable CfnDeployment.DeploymentConfigurationProperty value)
      Configuration settings for the deployment.

    • getDeploymentDescription

      @Stability(Stable) @Nullable public String getDeploymentDescription()
      A description of the deployment.

    • setDeploymentDescription

      @Stability(Stable) public void setDeploymentDescription(@Nullable String value)
      A description of the deployment.

    • getTags

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

    • setTags

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