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

Inherits:
Struct
  • Object
show all
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",
  elasticsearch_cluster_config: {
    dedicated_master_count: 1,
    dedicated_master_enabled: false,
    dedicated_master_type: "NonEmptyString",
    instance_count: 1,
    instance_type: "NonEmptyString",
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    zone_awareness_enabled: false,
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "NonEmptyString",
  },
  log_publishing_options: {
    index_slow_logs: {
      cloud_watch_logs_log_group_arn: "NonEmptyString",
      enabled: false,
    },
    search_slow_logs: {
      cloud_watch_logs_log_group_arn: "NonEmptyString",
      enabled: false,
    },
    audit_logs: {
      cloud_watch_logs_log_group_arn: "NonEmptyString",
      enabled: false,
    },
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  service_software_options: {
    automated_update_date: "NonEmptyString",
    cancellable: false,
    current_version: "NonEmptyString",
    description: "NonEmptyString",
    new_version: "NonEmptyString",
    update_available: false,
    update_status: "NonEmptyString",
  },
  vpc_options: {
    availability_zones: ["NonEmptyString"],
    security_group_ids: ["NonEmptyString"],
    subnet_ids: ["NonEmptyString"],
    vpc_id: "NonEmptyString",
  },
}

Information about an Elasticsearch domain.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM policy document specifying the access policies for the new Elasticsearch domain.

Returns:

  • (String)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#domain_endpoint_optionsTypes::AwsElasticsearchDomainDomainEndpointOptions

Additional options for the domain endpoint.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#domain_idString

Unique identifier for an Elasticsearch domain.

Returns:

  • (String)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#domain_nameString

Name of an Elasticsearch domain.

Domain names are unique across all domains owned by the same account within an Amazon Web Services 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)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#elasticsearch_cluster_configTypes::AwsElasticsearchDomainElasticsearchClusterConfigDetails

Information about an OpenSearch cluster configuration.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#elasticsearch_versionString

OpenSearch version.

Returns:

  • (String)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#encryption_at_rest_optionsTypes::AwsElasticsearchDomainEncryptionAtRestOptions

Details about the configuration for encryption at rest.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#endpointString

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

The endpoint is a service URL.

Returns:

  • (String)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#endpointsHash<String,String>

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

Returns:

  • (Hash<String,String>)


9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#log_publishing_optionsTypes::AwsElasticsearchDomainLogPublishingOptions

Configures the CloudWatch Logs to publish for the Elasticsearch domain.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#node_to_node_encryption_optionsTypes::AwsElasticsearchDomainNodeToNodeEncryptionOptions

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



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#service_software_optionsTypes::AwsElasticsearchDomainServiceSoftwareOptions

Information about the status of a domain relative to the latest service software.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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

#vpc_optionsTypes::AwsElasticsearchDomainVPCOptions

Information that OpenSearch derives based on VPCOptions for the domain.



9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 9426

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