Class CfnAccessPolicy

Creates a data access policy for OpenSearch Serverless.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAccessPolicy

Implements

IInspectable

IAccessPolicyRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.OpenSearchServerless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccessPolicy : CfnResource, IInspectable, IAccessPolicyRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnAccessPolicy Inherits CfnResource Implements IInspectable, IAccessPolicyRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.OpenSearchServerless;

             var cfnAccessPolicy = new CfnAccessPolicy(this, "MyCfnAccessPolicy", new CfnAccessPolicyProps {
                 Name = "name",
                 Policy = "policy",
                 Type = "type",

                 // the properties below are optional
                 Description = "description"
             });

Synopsis

Constructors

CfnAccessPolicy(Construct, string, ICfnAccessPolicyProps)

Create a new AWS::OpenSearchServerless::AccessPolicy.

Properties

AccessPolicyRef	A reference to a AccessPolicy resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a data access policy for OpenSearch Serverless.
Description	The description of the policy.
Name	The name of the policy.
Policy	The JSON policy document without any whitespaces.
Type	The type of access policy.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnAccessPolicy(object)	Checks whether the given object is a CfnAccessPolicy.
RenderProperties(IDictionary<string, object>)	Creates a data access policy for OpenSearch Serverless.

Constructors

CfnAccessPolicy(Construct, string, ICfnAccessPolicyProps)

Create a new AWS::OpenSearchServerless::AccessPolicy.

public CfnAccessPolicy(Construct scope, string id, ICfnAccessPolicyProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAccessPolicyProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Properties

AccessPolicyRef

A reference to a AccessPolicy resource.

public virtual IAccessPolicyReference AccessPolicyRef { get; }

Property Value

IAccessPolicyReference

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

CfnProperties

Creates a data access policy for OpenSearch Serverless.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Description

The description of the policy.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Name

The name of the policy.

public virtual string Name { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Policy

The JSON policy document without any whitespaces.

public virtual string Policy { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Type

The type of access policy.

public virtual string Type { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

IsCfnAccessPolicy(object)

Checks whether the given object is a CfnAccessPolicy.

public static bool IsCfnAccessPolicy(object x)

Parameters

x object

Returns

bool

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a data access policy for OpenSearch Serverless.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

CloudformationResource: AWS::OpenSearchServerless::AccessPolicy

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAccessPolicyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware