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",
  },
  advanced_security_options: {
    enabled: false,
    internal_user_database_enabled: false,
    master_user_options: {
      master_user_arn: "NonEmptyString",
      master_user_name: "NonEmptyString",
      master_user_password: "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)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_optionsTypes::AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails

Specifies options for fine-grained access control.



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The ARN of the OpenSearch Service domain.

Returns:

  • (String)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_configTypes::AwsOpenSearchServiceDomainClusterConfigDetails

Details about the configuration of an OpenSearch cluster.



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpointString

The domain endpoint.

Returns:

  • (String)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_optionsTypes::AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

Additional options for the domain endpoint.



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  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>)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The name of the endpoint.

Returns:

  • (String)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_optionsTypes::AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails

Details about the configuration for encryption at rest.



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The version of the domain engine.

Returns:

  • (String)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the domain.

Returns:

  • (String)


15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_optionsTypes::AwsOpenSearchServiceDomainLogPublishingOptionsDetails

Configures the CloudWatch Logs to publish for the OpenSearch domain.



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_optionsTypes::AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails

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



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#service_software_optionsTypes::AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

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



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_optionsTypes::AwsOpenSearchServiceDomainVpcOptionsDetails

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



15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15591

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,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end