software.amazon.awscdk.services.opensearchserverless

Class CfnAccessPolicy

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.999Z")
public class CfnAccessPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpenSearchServerless::AccessPolicy`.

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control 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.*;
 CfnAccessPolicy cfnAccessPolicy = CfnAccessPolicy.Builder.create(this, "MyCfnAccessPolicy")
         .description("description")
         .name("name")
         .policy("policy")
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAccessPolicy.Builder A fluent builder for CfnAccessPolicy.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccessPolicy(Construct scope, java.lang.String id) Create a new `AWS::OpenSearchServerless::AccessPolicy`.
	CfnAccessPolicy(Construct scope, java.lang.String id, CfnAccessPolicyProps props) Create a new `AWS::OpenSearchServerless::AccessPolicy`.
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the policy.
java.lang.String	getName() The name of the policy.
java.lang.String	getPolicy() The JSON policy document without any whitespaces.
java.lang.String	getType() The type of access policy.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) The description of the policy.
void	setName(java.lang.String value) The name of the policy.
void	setPolicy(java.lang.String value) The JSON policy document without any whitespaces.
void	setType(java.lang.String value) The type of access policy.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccessPolicy

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

CfnAccessPolicy

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

CfnAccessPolicy

public CfnAccessPolicy(Construct scope,
                       java.lang.String id,
                       CfnAccessPolicyProps props)

Create a new `AWS::OpenSearchServerless::AccessPolicy`.

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.

CfnAccessPolicy

public CfnAccessPolicy(Construct scope,
                       java.lang.String id)

Create a new `AWS::OpenSearchServerless::AccessPolicy`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

public java.lang.String getDescription()

The description of the policy.

setDescription

public void setDescription(java.lang.String value)

The description of the policy.

getName

public java.lang.String getName()

The name of the policy.

setName

public void setName(java.lang.String value)

The name of the policy.

getPolicy

public java.lang.String getPolicy()

The JSON policy document without any whitespaces.

setPolicy

public void setPolicy(java.lang.String value)

The JSON policy document without any whitespaces.

getType

public java.lang.String getType()

The type of access policy.

Currently the only option is data .

setType

public void setType(java.lang.String value)

The type of access policy.

Currently the only option is data .