Class CfnSecurityPolicy

All Implemented Interfaces:
IInspectable,, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.074Z") @Stability(Stable) public class CfnSecurityPolicy extends CfnResource implements IInspectable
Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnSecurityPolicy cfnSecurityPolicy = CfnSecurityPolicy.Builder.create(this, "MyCfnSecurityPolicy")
         // the properties below are optional

See Also:
  • Field Details


      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnSecurityPolicy

      protected CfnSecurityPolicy( objRef)
    • CfnSecurityPolicy

      protected CfnSecurityPolicy( initializationMode)
    • CfnSecurityPolicy

      @Stability(Stable) public CfnSecurityPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSecurityPolicyProps props)
      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

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getCfnProperties

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

      @Stability(Stable) @NotNull public String getName()
      The name of the policy.
    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the policy.
    • getPolicy

      @Stability(Stable) @NotNull public String getPolicy()
      The JSON policy document without any whitespaces.
    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull String value)
      The JSON policy document without any whitespaces.
    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of security policy.
    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of security policy.
    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the security policy.
    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the security policy.