Class CfnSecurityPolicy

Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSecurityPolicy

Implements

IInspectable

ISecurityPolicyRef

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.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.OpenSearchServerless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSecurityPolicy : CfnResource, IInspectable, ISecurityPolicyRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnSecurityPolicy Inherits CfnResource Implements IInspectable, ISecurityPolicyRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

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 cfnSecurityPolicy = new CfnSecurityPolicy(this, "MyCfnSecurityPolicy", new CfnSecurityPolicyProps {
                 Name = "name",
                 Policy = "policy",
                 Type = "type",

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

Synopsis

Constructors

CfnSecurityPolicy(Construct, string, ICfnSecurityPolicyProps)

Create a new AWS::OpenSearchServerless::SecurityPolicy.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.
Description	The description of the security policy.
Name	The name of the policy.
Policy	The JSON policy document without any whitespaces.
SecurityPolicyRef	A reference to a SecurityPolicy resource.
Type	The type of security policy.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSecurityPolicy(object)	Checks whether the given object is a CfnSecurityPolicy.
RenderProperties(IDictionary<string, object>)	Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.

Constructors

CfnSecurityPolicy(Construct, string, ICfnSecurityPolicyProps)

Create a new AWS::OpenSearchServerless::SecurityPolicy.

public CfnSecurityPolicy(Construct scope, string id, ICfnSecurityPolicyProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnSecurityPolicyProps

Resource properties.

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Properties

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

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

CfnProperties

Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Description

The description of the security policy.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Name

The name of the policy.

public virtual string Name { get; set; }

Property Value

string

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Policy

The JSON policy document without any whitespaces.

public virtual string Policy { get; set; }

Property Value

string

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

SecurityPolicyRef

A reference to a SecurityPolicy resource.

public virtual ISecurityPolicyReference SecurityPolicyRef { get; }

Property Value

ISecurityPolicyReference

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Type

The type of security policy.

public virtual string Type { get; set; }

Property Value

string

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

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

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

IsCfnSecurityPolicy(object)

Checks whether the given object is a CfnSecurityPolicy.

public static bool IsCfnSecurityPolicy(object x)

Parameters

x object

Returns

bool

Remarks

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.

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

Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see Network access for Amazon OpenSearch Serverless .

Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see Encryption at rest for Amazon OpenSearch Serverless .

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

CloudformationResource: AWS::OpenSearchServerless::SecurityPolicy

ExampleMetadata: fixture=_generated

Implements

IInspectable

ISecurityPolicyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware