Class: Aws::SecurityHub::Types::AwsElasticsearchDomainDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsElasticsearchDomainDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsElasticsearchDomainDetails data as a hash:

{
  access_policies: "NonEmptyString",
  domain_endpoint_options: {
    enforce_https: false,
    tls_security_policy: "NonEmptyString",
  },
  domain_id: "NonEmptyString",
  domain_name: "NonEmptyString",
  endpoint: "NonEmptyString",
  endpoints: {
    "NonEmptyString" => "NonEmptyString",
  },
  elasticsearch_version: "NonEmptyString",
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "NonEmptyString",
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  vpc_options: {
    availability_zones: ["NonEmptyString"],
    security_group_ids: ["NonEmptyString"],
    subnet_ids: ["NonEmptyString"],
    vpc_id: "NonEmptyString",
  },
}

Information about an Elasticsearch domain.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_policies ⇒ String

  IAM policy document specifying the access policies for the new Amazon ES domain.

• #domain_endpoint_options ⇒ Types::AwsElasticsearchDomainDomainEndpointOptions

  Additional options for the domain endpoint.

• #domain_id ⇒ String

  Unique identifier for an Amazon ES domain.

• #domain_name ⇒ String

  Name of an Amazon ES domain.

• #elasticsearch_version ⇒ String

  Elasticsearch version.

• #encryption_at_rest_options ⇒ Types::AwsElasticsearchDomainEncryptionAtRestOptions

  Details about the configuration for encryption at rest.

• #endpoint ⇒ String

  Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.

• #endpoints ⇒ Hash<String,String>

  The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

• #node_to_node_encryption_options ⇒ Types::AwsElasticsearchDomainNodeToNodeEncryptionOptions

  Details about the configuration for node-to-node encryption.

• #vpc_options ⇒ Types::AwsElasticsearchDomainVPCOptions

  Information that Amazon ES derives based on VPCOptions for the domain.

Instance Attribute Details

#access_policies ⇒ String

IAM policy document specifying the access policies for the new Amazon ES domain.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_options ⇒ Types::AwsElasticsearchDomainDomainEndpointOptions

Additional options for the domain endpoint.

Returns:

• (Types::AwsElasticsearchDomainDomainEndpointOptions)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_id ⇒ String

Unique identifier for an Amazon ES domain.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

Name of an Amazon ES domain.

Domain names are unique across all domains owned by the same account within an AWS Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_version ⇒ String

Elasticsearch version.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ Types::AwsElasticsearchDomainEncryptionAtRestOptions

Details about the configuration for encryption at rest.

Returns:

• (Types::AwsElasticsearchDomainEncryptionAtRestOptions)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.

The endpoint is a service URL.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#endpoints ⇒ Hash<String,String>

The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_options ⇒ Types::AwsElasticsearchDomainNodeToNodeEncryptionOptions

Details about the configuration for node-to-node encryption.

Returns:

• (Types::AwsElasticsearchDomainNodeToNodeEncryptionOptions)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_options ⇒ Types::AwsElasticsearchDomainVPCOptions

Information that Amazon ES derives based on VPCOptions for the domain.

Returns:

• (Types::AwsElasticsearchDomainVPCOptions)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1470

class AwsElasticsearchDomainDetails < Struct.new(
  :access_policies,
  :domain_endpoint_options,
  :domain_id,
  :domain_name,
  :endpoint,
  :endpoints,
  :elasticsearch_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :vpc_options)
  SENSITIVE = []
  include Aws::Structure
end