DomainConfig - Amazon OpenSearch Service

DomainConfig

Container for the configuration of an OpenSearch Service domain.

Contents

AccessPolicies

Specifies the access policies for the domain.

Type: AccessPoliciesStatus object

Required: No

AdvancedOptions

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

Type: AdvancedOptionsStatus object

Required: No

AdvancedSecurityOptions

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

Type: AdvancedSecurityOptionsStatus object

Required: No

AIMLOptions

Container for parameters required to enable all machine learning features.

Type: AIMLOptionsStatus object

Required: No

AutoTuneOptions

Container for Auto-Tune settings for the domain.

Type: AutoTuneOptionsStatus object

Required: No

ChangeProgressDetails

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

Type: ChangeProgressDetails object

Required: No

ClusterConfig

Container for the cluster configuration of a the domain.

Type: ClusterConfigStatus object

Required: No

CognitoOptions

Container for Amazon Cognito options for the domain.

Type: CognitoOptionsStatus object

Required: No

DomainEndpointOptions

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

Type: DomainEndpointOptionsStatus object

Required: No

EBSOptions

Container for EBS options configured for the domain.

Type: EBSOptionsStatus object

Required: No

EncryptionAtRestOptions

Key-value pairs to enable encryption at rest.

Type: EncryptionAtRestOptionsStatus object

Required: No

EngineVersion

The OpenSearch or Elasticsearch version that the domain is running.

Type: VersionStatus object

Required: No

IdentityCenterOptions

Container for IAM Identity Center Option control for the domain.

Type: IdentityCenterOptionsStatus object

Required: No

IPAddressType

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.

Type: IPAddressTypeStatus object

Required: No

LogPublishingOptions

Key-value pairs to configure log publishing.

Type: LogPublishingOptionsStatus object

Required: No

ModifyingProperties

Information about the domain properties that are currently being modified.

Type: Array of ModifyingProperties objects

Required: No

NodeToNodeEncryptionOptions

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

Type: NodeToNodeEncryptionOptionsStatus object

Required: No

OffPeakWindowOptions

Container for off-peak window options for the domain.

Type: OffPeakWindowOptionsStatus object

Required: No

SnapshotOptions

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

Type: SnapshotOptionsStatus object

Required: No

SoftwareUpdateOptions

Software update options for the domain.

Type: SoftwareUpdateOptionsStatus object

Required: No

VPCOptions

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

Type: VPCDerivedInfoStatus object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: