Class: Aws::OpenSearchService::Types::DomainStatus

Inherits:

Struct

Object
Struct
Aws::OpenSearchService::Types::DomainStatus

show all

Includes:: Structure

Defined in:: lib/aws-sdk-opensearchservice/types.rb

Overview

The current status of an OpenSearch Service domain.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#access_policies ⇒ String

Identity and Access Management (IAM) policy document specifying the access policies for the domain.
#advanced_options ⇒ Hash<String,String>

Key-value pairs that specify advanced configuration options.
#advanced_security_options ⇒ Types::AdvancedSecurityOptions

Settings for fine-grained access control.
#arn ⇒ String

The Amazon Resource Name (ARN) of the domain.
#auto_tune_options ⇒ Types::AutoTuneOptionsOutput

Auto-Tune settings for the domain.
#change_progress_details ⇒ Types::ChangeProgressDetails

Information about a configuration change happening on the domain.
#cluster_config ⇒ Types::ClusterConfig

Container for the cluster configuration of the domain.
#cognito_options ⇒ Types::CognitoOptions

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
#created ⇒ Boolean

Creation status of an OpenSearch Service domain.
#deleted ⇒ Boolean

Deletion status of an OpenSearch Service domain.
#domain_endpoint_options ⇒ Types::DomainEndpointOptions

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
#domain_endpoint_v2_hosted_zone_id ⇒ String

The dual stack hosted zone ID for the domain.
#domain_id ⇒ String

Unique identifier for the domain.
#domain_name ⇒ String

Name of the domain.
#domain_processing_status ⇒ String

The status of any changes that are currently in progress for the domain.
#ebs_options ⇒ Types::EBSOptions

Container for EBS-based storage settings for the domain.
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Encryption at rest settings for the domain.
#endpoint ⇒ String

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
#endpoint_v2 ⇒ String

If ‘IPAddressType` to set to `dualstack`, a version 2 domain endpoint is provisioned.
#endpoints ⇒ Hash<String,String>

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.
#engine_version ⇒ String

Version of OpenSearch or Elasticsearch that the domain is running, in the format ‘Elasticsearch_X.Y` or `OpenSearch_X.Y`.
#ip_address_type ⇒ String

The type of IP addresses supported by the endpoint for the domain.
#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

Log publishing options for the domain.
#modifying_properties ⇒ Array<Types::ModifyingProperties>

Information about the domain properties that are currently being modified.
#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

Whether node-to-node encryption is enabled or disabled.
#off_peak_window_options ⇒ Types::OffPeakWindowOptions

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
#processing ⇒ Boolean

The status of the domain configuration.
#service_software_options ⇒ Types::ServiceSoftwareOptions

The current status of the domain’s service software.
#snapshot_options ⇒ Types::SnapshotOptions

DEPRECATED.
#software_update_options ⇒ Types::SoftwareUpdateOptions

Service software update options for the domain.
#upgrade_processing ⇒ Boolean

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch.
#vpc_options ⇒ Types::VPCDerivedInfo

The VPC configuration for the domain.

Instance Attribute Details

#access_policies ⇒ `String`

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_options ⇒ `Hash<String,String>`

Key-value pairs that specify advanced configuration options.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_options ⇒ `Types::AdvancedSecurityOptions`

Settings for fine-grained access control.

Returns:

(Types::AdvancedSecurityOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the domain. For more information, see [IAM identifiers ][1] in the *AWS Identity and Access Management User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#auto_tune_options ⇒ `Types::AutoTuneOptionsOutput`

Auto-Tune settings for the domain.

Returns:

(Types::AutoTuneOptionsOutput)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#change_progress_details ⇒ `Types::ChangeProgressDetails`

Information about a configuration change happening on the domain.

Returns:

(Types::ChangeProgressDetails)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_config ⇒ `Types::ClusterConfig`

Container for the cluster configuration of the domain.

Returns:

(Types::ClusterConfig)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#cognito_options ⇒ `Types::CognitoOptions`

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

(Types::CognitoOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#created ⇒ `Boolean`

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#deleted ⇒ `Boolean`

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_options ⇒ `Types::DomainEndpointOptions`

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Returns:

(Types::DomainEndpointOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_v2_hosted_zone_id ⇒ `String`

The dual stack hosted zone ID for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#domain_id ⇒ `String`

Unique identifier for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ `String`

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#domain_processing_status ⇒ `String`

The status of any changes that are currently in progress for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_options ⇒ `Types::EBSOptions`

Container for EBS-based storage settings for the domain.

Returns:

(Types::EBSOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

Encryption at rest settings for the domain.

Returns:

(Types::EncryptionAtRestOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_v2 ⇒ `String`

If ‘IPAddressType` to set to `dualstack`, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#endpoints ⇒ `Hash<String,String>`

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

**IPv4 IP addresses** - ‘’vpc’,‘vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com’‘
**Dual stack IP addresses** - ‘’vpcv2’:‘vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws’‘

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

Version of OpenSearch or Elasticsearch that the domain is running, in the format ‘Elasticsearch_X.Y` or `OpenSearch_X.Y`.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ `String`

The type of IP addresses supported by the endpoint for the domain.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ `Hash<String,Types::LogPublishingOption>`

Log publishing options for the domain.

Returns:

(Hash<String,Types::LogPublishingOption>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#modifying_properties ⇒ `Array<Types::ModifyingProperties>`

Information about the domain properties that are currently being modified.

Returns:

(Array<Types::ModifyingProperties>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_options ⇒ `Types::NodeToNodeEncryptionOptions`

Whether node-to-node encryption is enabled or disabled.

Returns:

(Types::NodeToNodeEncryptionOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#off_peak_window_options ⇒ `Types::OffPeakWindowOptions`

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Returns:

(Types::OffPeakWindowOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#processing ⇒ `Boolean`

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#service_software_options ⇒ `Types::ServiceSoftwareOptions`

The current status of the domain’s service software.

Returns:

(Types::ServiceSoftwareOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_options ⇒ `Types::SnapshotOptions`

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Returns:

(Types::SnapshotOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#software_update_options ⇒ `Types::SoftwareUpdateOptions`

Service software update options for the domain.

Returns:

(Types::SoftwareUpdateOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_processing ⇒ `Boolean`

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_options ⇒ `Types::VPCDerivedInfo`

The VPC configuration for the domain.

Returns:

(Types::VPCDerivedInfo)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 3172

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :endpoint_v2,
  :endpoints,
  :domain_endpoint_v2_hosted_zone_id,
  :processing,
  :upgrade_processing,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :service_software_options,
  :domain_endpoint_options,
  :advanced_security_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :domain_processing_status,
  :modifying_properties)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OpenSearchService::Types::DomainStatus

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_policies ⇒ String

#advanced_options ⇒ Hash<String,String>

#advanced_security_options ⇒ Types::AdvancedSecurityOptions

#arn ⇒ String

#auto_tune_options ⇒ Types::AutoTuneOptionsOutput

#change_progress_details ⇒ Types::ChangeProgressDetails

#cluster_config ⇒ Types::ClusterConfig

#cognito_options ⇒ Types::CognitoOptions

#created ⇒ Boolean

#deleted ⇒ Boolean

#domain_endpoint_options ⇒ Types::DomainEndpointOptions

#domain_endpoint_v2_hosted_zone_id ⇒ String

#domain_id ⇒ String

#domain_name ⇒ String

#domain_processing_status ⇒ String

#ebs_options ⇒ Types::EBSOptions

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

#endpoint ⇒ String

#endpoint_v2 ⇒ String

#endpoints ⇒ Hash<String,String>

#engine_version ⇒ String

#ip_address_type ⇒ String

#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

#modifying_properties ⇒ Array<Types::ModifyingProperties>

#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

#off_peak_window_options ⇒ Types::OffPeakWindowOptions

#processing ⇒ Boolean

#service_software_options ⇒ Types::ServiceSoftwareOptions

#snapshot_options ⇒ Types::SnapshotOptions

#software_update_options ⇒ Types::SoftwareUpdateOptions

#upgrade_processing ⇒ Boolean

#vpc_options ⇒ Types::VPCDerivedInfo

#access_policies ⇒ `String`

#advanced_options ⇒ `Hash<String,String>`

#advanced_security_options ⇒ `Types::AdvancedSecurityOptions`

#arn ⇒ `String`

#auto_tune_options ⇒ `Types::AutoTuneOptionsOutput`

#change_progress_details ⇒ `Types::ChangeProgressDetails`

#cluster_config ⇒ `Types::ClusterConfig`

#cognito_options ⇒ `Types::CognitoOptions`

#created ⇒ `Boolean`

#deleted ⇒ `Boolean`

#domain_endpoint_options ⇒ `Types::DomainEndpointOptions`

#domain_endpoint_v2_hosted_zone_id ⇒ `String`

#domain_id ⇒ `String`

#domain_name ⇒ `String`

#domain_processing_status ⇒ `String`

#ebs_options ⇒ `Types::EBSOptions`

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

#endpoint ⇒ `String`

#endpoint_v2 ⇒ `String`

#endpoints ⇒ `Hash<String,String>`

#engine_version ⇒ `String`

#ip_address_type ⇒ `String`

#log_publishing_options ⇒ `Hash<String,Types::LogPublishingOption>`

#modifying_properties ⇒ `Array<Types::ModifyingProperties>`

#node_to_node_encryption_options ⇒ `Types::NodeToNodeEncryptionOptions`

#off_peak_window_options ⇒ `Types::OffPeakWindowOptions`

#processing ⇒ `Boolean`

#service_software_options ⇒ `Types::ServiceSoftwareOptions`

#snapshot_options ⇒ `Types::SnapshotOptions`

#software_update_options ⇒ `Types::SoftwareUpdateOptions`

#upgrade_processing ⇒ `Boolean`

#vpc_options ⇒ `Types::VPCDerivedInfo`