Package software.amazon.awscdk.services.opensearchserverless

Class CfnAccessPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnAccessPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessPolicy>

Enclosing class:

CfnAccessPolicy

@Stability(Stable)
public static final class CfnAccessPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccessPolicy>

A fluent builder for CfnAccessPolicy.

Method Summary

Modifier and Type	Method	Description
CfnAccessPolicy	build()
static CfnAccessPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnAccessPolicy.Builder	description(String description)	The description of the policy.
CfnAccessPolicy.Builder	name(String name)	The name of the policy.
CfnAccessPolicy.Builder	policy(String policy)	The JSON policy document without any whitespaces.
CfnAccessPolicy.Builder	type(String type)	The type of access policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccessPolicy.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnAccessPolicy.Builder.

name

@Stability(Stable)
public CfnAccessPolicy.Builder name(String name)

The name of the policy.

Parameters:

name - The name of the policy. This parameter is required.

Returns:

this

See Also:

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

policy

@Stability(Stable)
public CfnAccessPolicy.Builder policy(String policy)

The JSON policy document without any whitespaces.

Parameters:

policy - The JSON policy document without any whitespaces. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnAccessPolicy.Builder type(String type)

The type of access policy.

Currently the only option is data .

Parameters:

type - The type of access policy. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnAccessPolicy.Builder description(String description)

The description of the policy.

Parameters:

description - The description of the policy. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccessPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccessPolicy>

Returns:

a newly built instance of CfnAccessPolicy.