Class CfnSecurityPolicy
A CloudFormation AWS::OpenSearchServerless::SecurityPolicy
.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchServerless
Assembly: Amazon.CDK.AWS.OpenSearchServerless.dll
Syntax (csharp)
public class CfnSecurityPolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSecurityPolicy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.
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 .
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 |
CfnSecurityPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSecurityPolicy(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 security policy. |
Name | The name of the policy. |
Policy | The JSON policy document without any whitespaces. |
Type | The type of security policy. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnSecurityPolicyProps
- resource properties.
CfnSecurityPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSecurityPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSecurityPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSecurityPolicy(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 security 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 security policy.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Can be either encryption
or network
.
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>