Show / Hide Table of Contents

Class CfnDomain.VPCOptionsProperty

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

Inheritance
System.Object
CfnDomain.VPCOptionsProperty
Implements
CfnDomain.IVPCOptionsProperty
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.AWS.OpenSearchService.dll
Syntax (csharp)
public class VPCOptionsProperty : Object, CfnDomain.IVPCOptionsProperty
Syntax (vb)
Public Class VPCOptionsProperty
    Inherits Object
    Implements CfnDomain.IVPCOptionsProperty
Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-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.OpenSearchService;

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

Synopsis

Constructors

VPCOptionsProperty()

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()

public VPCOptionsProperty()

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

System.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 .

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

SubnetIds

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

public string[] SubnetIds { get; set; }
Property Value

System.String[]

Remarks

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

If you specify more than one subnet, you must also configure ZoneAwarenessEnabled and ZoneAwarenessConfig within ClusterConfig , otherwise you'll see the error "You must specify exactly one subnet" during template creation.

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

Implements

CfnDomain.IVPCOptionsProperty
Back to top Generated by DocFX