Class CfnDomainPropsMixin.VPCOptionsProperty

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

Inheritance

object

CfnDomainPropsMixin.VPCOptionsProperty

Implements

CfnDomainPropsMixin.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.CfnPropertyMixins.AWS.OpenSearchService

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDomainPropsMixin.VPCOptionsProperty : CfnDomainPropsMixin.IVPCOptionsProperty

Syntax (vb)

Public Class CfnDomainPropsMixin.VPCOptionsProperty Implements CfnDomainPropsMixin.IVPCOptionsProperty

Remarks

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

See: 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.CfnPropertyMixins.AWS.OpenSearchService;

             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 .

See: 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.CfnPropertyMixins.AWS.OpenSearchService;

             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 object[]? SecurityGroupIds { get; set; }

Property Value

object[]

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-opensearchservice-domain-vpcoptions.html#cfn-opensearchservice-domain-vpcoptions-securitygroupids

Type union: (either string or ISecurityGroupRef)[]

SubnetIds

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

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

Property Value

object[]

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.

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

Type union: (either string or ISubnetRef)[]

Implements

CfnDomainPropsMixin.IVPCOptionsProperty