Package software.amazon.awscdk.services.opensearchserverless

Class CfnSecurityPolicy

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.opensearchserverless.CfnSecurityPolicy
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.558Z") @Stability(Stable) public class CfnSecurityPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::OpenSearchServerless::SecurityPolicy.

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 .

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.opensearchserverless.*;
 CfnSecurityPolicy cfnSecurityPolicy = CfnSecurityPolicy.Builder.create(this, "MyCfnSecurityPolicy")
         .name("name")
         .policy("policy")
         .type("type")
         // the properties below are optional
         .description("description")
         .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

    • CfnSecurityPolicy

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

    • CfnSecurityPolicy

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

    • CfnSecurityPolicy

      @Stability(Stable) public CfnSecurityPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnSecurityPolicyProps props)
      Create a new AWS::OpenSearchServerless::SecurityPolicy.

      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      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.

      Can be either encryption or network .

    • setType

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

      Can be either encryption or network .

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