Class CfnDomain.VPCOptionsProperty

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Inheritance

object

CfnDomain.VPCOptionsProperty

Implements

CfnDomain.IVPCOptionsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomain.VPCOptionsProperty : CfnDomain.IVPCOptionsProperty

Syntax (vb)

Public Class CfnDomain.VPCOptionsProperty Implements CfnDomain.IVPCOptionsProperty

Remarks

For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html

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.Elasticsearch;

             var vPCOptionsProperty = new VPCOptionsProperty {
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SubnetIds = new [] { "subnetIds" }
             };

Synopsis

Constructors

VPCOptionsProperty()

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Properties

SecurityGroupIds	The list of security group IDs that are associated with the VPC endpoints for the domain.
SubnetIds	Provide one subnet ID for each Availability Zone that your domain uses.

Constructors

VPCOptionsProperty()

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

public VPCOptionsProperty()

Remarks

For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html

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.Elasticsearch;

             var vPCOptionsProperty = new VPCOptionsProperty {
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SubnetIds = new [] { "subnetIds" }
             };

Properties

SecurityGroupIds

The list of security group IDs that are associated with the VPC endpoints for the domain.

public string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see Security groups for your VPC in the Amazon VPC User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids

SubnetIds

Provide one subnet ID for each Availability Zone that your domain uses.

public string[]? SubnetIds { get; set; }

Property Value

string[]

Remarks

For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .

Required if you're creating your domain inside a VPC.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids

Implements

CfnDomain.IVPCOptionsProperty