Class: AWSCDK::Elasticsearch::CfnDomain::VPCOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Elasticsearch::CfnDomain::VPCOptionsProperty

Defined in:

elasticsearch/cfn_domain.rb

Overview

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

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

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 New resource types in the Amazon OpenSearch Service Developer Guide .

See Also:

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

Instance Attribute Summary

• #security_group_ids ⇒ Array<String>^? readonly

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

• #subnet_ids ⇒ Array<String>^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(security_group_ids: nil, subnet_ids: nil) ⇒ VPCOptionsProperty constructor

  A new instance of VPCOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(security_group_ids: nil, subnet_ids: nil) ⇒ VPCOptionsProperty

Returns a new instance of VPCOptionsProperty.

Parameters:

• security_group_ids (Array<String>, nil) (defaults to: nil) —

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

• subnet_ids (Array<String>, nil) (defaults to: nil) —

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

# File 'elasticsearch/cfn_domain.rb', line 1482

def initialize(security_group_ids: nil, subnet_ids: nil)
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @subnet_ids = subnet_ids
  Jsii::Type.check_type(@subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") unless @subnet_ids.nil?
end

Instance Attribute Details

#security_group_ids ⇒ Array<String>^? (readonly)

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

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 .

Returns:

• (Array<String>, nil)

See Also:

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

# File 'elasticsearch/cfn_domain.rb', line 1495

def security_group_ids
  @security_group_ids
end

#subnet_ids ⇒ Array<String>^? (readonly)

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

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.

Returns:

• (Array<String>, nil)

See Also:

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

# File 'elasticsearch/cfn_domain.rb', line 1504

def subnet_ids
  @subnet_ids
end

Class Method Details

.jsii_properties ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1506

def self.jsii_properties
  {
    :security_group_ids => "securityGroupIds",
    :subnet_ids => "subnetIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1513

def to_jsii
  result = {}
  result.merge!({
    "securityGroupIds" => @security_group_ids,
    "subnetIds" => @subnet_ids,
  })
  result.compact
end