Class CfnAccessPolicy
A CloudFormation AWS::OpenSearchServerless::AccessPolicy
.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchServerless
Assembly: Amazon.CDK.AWS.OpenSearchServerless.dll
Syntax (csharp)
public class CfnAccessPolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAccessPolicy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
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 |
CfnAccessPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccessPolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnAccessPolicyProps
- resource properties.
CfnAccessPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccessPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccessPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccessPolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the policy.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the policy.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Policy
The JSON policy document without any whitespaces.
public virtual string Policy { get; set; }
Property Value
System.String
Remarks
Type
The type of access policy.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Currently the only option is data
.
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>