Class: Aws::OpenSearchService::Types::DomainConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Container for the configuration of an OpenSearch Service domain.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesTypes::AccessPoliciesStatus

Specifies the access policies for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_optionsTypes::AdvancedOptionsStatus

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_optionsTypes::AdvancedSecurityOptionsStatus

Container for fine-grained access control settings for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#aiml_optionsTypes::AIMLOptionsStatus

Container for parameters required to enable all machine learning features.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#auto_tune_optionsTypes::AutoTuneOptionsStatus

Container for Auto-Tune settings for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#change_progress_detailsTypes::ChangeProgressDetails

Container for information about the progress of an existing configuration change.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_configTypes::ClusterConfigStatus

Container for the cluster configuration of a the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#cognito_optionsTypes::CognitoOptionsStatus

Container for Amazon Cognito options for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_strategy_optionsTypes::DeploymentStrategyOptionsStatus

Specifies DeploymentStrategyOptions for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_optionsTypes::DomainEndpointOptionsStatus

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



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_optionsTypes::EBSOptionsStatus

Container for EBS options configured for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_optionsTypes::EncryptionAtRestOptionsStatus

Key-value pairs to enable encryption at rest.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionTypes::VersionStatus

The OpenSearch or Elasticsearch version that the domain is running.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_optionsTypes::IdentityCenterOptionsStatus

Configuration options for enabling and managing IAM Identity Center integration within a domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_typeTypes::IPAddressTypeStatus

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_optionsTypes::LogPublishingOptionsStatus

Key-value pairs to configure log publishing.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#modifying_propertiesArray<Types::ModifyingProperties>

Information about the domain properties that are currently being modified.

Returns:



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_optionsTypes::NodeToNodeEncryptionOptionsStatus

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



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#off_peak_window_optionsTypes::OffPeakWindowOptionsStatus

Container for off-peak window options for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_optionsTypes::SnapshotOptionsStatus

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



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#software_update_optionsTypes::SoftwareUpdateOptionsStatus

Software update options for the domain.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_optionsTypes::VPCDerivedInfoStatus

The current VPC options for the domain and the status of any updates to their configuration.



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 3469

class DomainConfig < Struct.new(
  :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,
  :domain_endpoint_options,
  :advanced_security_options,
  :identity_center_options,
  :auto_tune_options,
  :change_progress_details,
  :off_peak_window_options,
  :software_update_options,
  :modifying_properties,
  :aiml_options,
  :deployment_strategy_options)
  SENSITIVE = []
  include Aws::Structure
end