Package software.amazon.awscdk.services.opensearchserverless

Class CfnAccessPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opensearchserverless.CfnAccessPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:10.246Z")
@Stability(Stable)
public class CfnAccessPolicy
extends CfnResource
implements IInspectable

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")
         .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-accesspolicy.html

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccessPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAccessPolicy(software.constructs.Construct scope, String id, CfnAccessPolicyProps props)

Method Summary

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

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnAccessPolicy

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

CfnAccessPolicy

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

CfnAccessPolicy

@Stability(Stable)
public CfnAccessPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAccessPolicyProps props)

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.

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 access policy.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of access policy.

getDescription

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

The description of the policy.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the policy.