Package software.amazon.awscdk.services.opensearchserverless

Interface CfnSecurityPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:20.032Z")
@Stability(Stable)
public interface CfnSecurityPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSecurityPolicy.

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.*;
 CfnSecurityPolicyProps cfnSecurityPolicyProps = CfnSecurityPolicyProps.builder()
         .name("name")
         .policy("policy")
         .type("type")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityPolicyProps.Builder	A builder for CfnSecurityPolicyProps
static final class	CfnSecurityPolicyProps.Jsii$Proxy	An implementation for CfnSecurityPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnSecurityPolicyProps.Builder	builder()
default String	getDescription()	The description of the security policy.
String	getName()	The name of the policy.
String	getPolicy()	The JSON policy document without any whitespaces.
String	getType()	The type of security policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-name

getPolicy

@Stability(Stable)
@NotNull
String getPolicy()

The JSON policy document without any whitespaces.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-policy

getType

@Stability(Stable)
@NotNull
String getType()

The type of security policy.

Can be either encryption or network .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-type

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the security policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-description

builder

@Stability(Stable)
static CfnSecurityPolicyProps.Builder builder()

Returns:

a CfnSecurityPolicyProps.Builder of CfnSecurityPolicyProps