Class: Aws::SecurityHub::Types::AwsOpenSearchServiceDomainDetails

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 AwsOpenSearchServiceDomainDetails data as a hash:

{
  arn: "NonEmptyString",
  access_policies: "NonEmptyString",
  domain_name: "NonEmptyString",
  id: "NonEmptyString",
  domain_endpoint: "NonEmptyString",
  engine_version: "NonEmptyString",
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "NonEmptyString",
  },
  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",
    optional_deployment: false,
  },
  cluster_config: {
    instance_count: 1,
    warm_enabled: false,
    warm_count: 1,
    dedicated_master_enabled: false,
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    dedicated_master_count: 1,
    instance_type: "NonEmptyString",
    warm_type: "NonEmptyString",
    zone_awareness_enabled: false,
    dedicated_master_type: "NonEmptyString",
  },
  domain_endpoint_options: {
    custom_endpoint_certificate_arn: "NonEmptyString",
    custom_endpoint_enabled: false,
    enforce_https: false,
    custom_endpoint: "NonEmptyString",
    tls_security_policy: "NonEmptyString",
  },
  vpc_options: {
    security_group_ids: ["NonEmptyString"],
    subnet_ids: ["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,
    },
  },
  domain_endpoints: {
    "NonEmptyString" => "NonEmptyString",
  },
}

Information about an Amazon OpenSearch Service domain.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM policy document that specifies the access policies for the OpenSearch Service domain.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The ARN of the OpenSearch Service domain.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_configTypes::AwsOpenSearchServiceDomainClusterConfigDetails

Details about the configuration of an OpenSearch cluster.



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpointString

The domain endpoint.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_optionsTypes::AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

Additional options for the domain endpoint.



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpointsHash<String,String>

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

Returns:

  • (Hash<String,String>)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The name of the endpoint.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_optionsTypes::AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails

Details about the configuration for encryption at rest.



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The version of the domain engine.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the domain.

Returns:

  • (String)


12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_optionsTypes::AwsOpenSearchServiceDomainLogPublishingOptionsDetails

Configures the CloudWatch Logs to publish for the OpenSearch domain.



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_optionsTypes::AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails

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



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#service_software_optionsTypes::AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

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



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_optionsTypes::AwsOpenSearchServiceDomainVpcOptionsDetails

Information that OpenSearch Service derives based on VPCOptions for the domain.



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 12257

class AwsOpenSearchServiceDomainDetails < Struct.new(
  :arn,
  :access_policies,
  :domain_name,
  :id,
  :domain_endpoint,
  :engine_version,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :service_software_options,
  :cluster_config,
  :domain_endpoint_options,
  :vpc_options,
  :log_publishing_options,
  :domain_endpoints)
  SENSITIVE = []
  include Aws::Structure
end