Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]

describe-domain-config

Description

Returns the configuration of an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Synopsis

  describe-domain-config
--domain-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain-name (string)

Name of the OpenSearch Service domain configuration that you want to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

DomainConfig -> (structure)

Container for the configuration of the OpenSearch Service domain.

EngineVersion -> (structure)

The OpenSearch or Elasticsearch version that the domain is running.

Options -> (string)

The OpenSearch or Elasticsearch version for the specified domain.

Status -> (structure)

The status of the version options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

ClusterConfig -> (structure)

Container for the cluster configuration of a the domain.

Options -> (structure)

Cluster configuration options for the specified domain.

InstanceType -> (string)

Instance type of data nodes in the cluster.

InstanceCount -> (integer)

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

DedicatedMasterEnabled -> (boolean)

Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

ZoneAwarenessEnabled -> (boolean)

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

ZoneAwarenessConfig -> (structure)

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

AvailabilityZoneCount -> (integer)

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

DedicatedMasterType -> (string)

OpenSearch Service instance type of the dedicated master nodes in the cluster.

DedicatedMasterCount -> (integer)

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

WarmEnabled -> (boolean)

Whether to enable warm storage for the cluster.

WarmType -> (string)

The instance type for the cluster's warm nodes.

WarmCount -> (integer)

The number of warm nodes in the cluster.

ColdStorageOptions -> (structure)

Container for cold storage configuration options.

Enabled -> (boolean)

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

MultiAZWithStandbyEnabled -> (boolean)

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

Status -> (structure)

The status of cluster configuration options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

EBSOptions -> (structure)

Container for EBS options configured for the domain.

Options -> (structure)

The configured EBS options for the specified domain.

EBSEnabled -> (boolean)

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

VolumeType -> (string)

Specifies the type of EBS volumes attached to data nodes.

VolumeSize -> (integer)

Specifies the size (in GiB) of EBS volumes attached to data nodes.

Iops -> (integer)

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

Throughput -> (integer)

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

Status -> (structure)

The status of the EBS options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

AccessPolicies -> (structure)

Specifies the access policies for the domain.

Options -> (string)

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies .

Status -> (structure)

The status of the access policy for the domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

IPAddressType -> (structure)

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.

Options -> (string)

The IP address options for the domain.

Status -> (structure)

Provides the current status of an entity.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

SnapshotOptions -> (structure)

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

Options -> (structure)

The daily snapshot options specified for the domain.

AutomatedSnapshotStartHour -> (integer)

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

Status -> (structure)

The status of a daily automated snapshot.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

VPCOptions -> (structure)

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

Options -> (structure)

The VPC options for the specified domain.

VPCId -> (string)

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

SubnetIds -> (list)

A list of subnet IDs associated with the VPC endpoints for the domain.

(string)

AvailabilityZones -> (list)

The list of Availability Zones associated with the VPC subnets.

(string)

SecurityGroupIds -> (list)

The list of security group IDs associated with the VPC endpoints for the domain.

(string)

Status -> (structure)

The status of the VPC options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

CognitoOptions -> (structure)

Container for Amazon Cognito options for the domain.

Options -> (structure)

Cognito options for the specified domain.

Enabled -> (boolean)

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

UserPoolId -> (string)

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

IdentityPoolId -> (string)

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

RoleArn -> (string)

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

Status -> (structure)

The status of the Cognito options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

EncryptionAtRestOptions -> (structure)

Key-value pairs to enable encryption at rest.

Options -> (structure)

Encryption at rest options for the specified domain.

Enabled -> (boolean)

True to enable encryption at rest.

KmsKeyId -> (string)

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

Status -> (structure)

The status of the encryption at rest options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

NodeToNodeEncryptionOptions -> (structure)

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

Options -> (structure)

The node-to-node encryption options for the specified domain.

Enabled -> (boolean)

True to enable node-to-node encryption.

Status -> (structure)

The status of the node-to-node encryption options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

AdvancedOptions -> (structure)

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

Options -> (map)

The status of advanced options for the specified domain.

key -> (string)

value -> (string)

Status -> (structure)

The status of advanced options for the specified domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

LogPublishingOptions -> (structure)

Key-value pairs to configure log publishing.

Options -> (map)

The log publishing options configured for the domain.

key -> (string)

The type of log file. Can be one of the following:

• INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
• SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.
• ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
• AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

value -> (structure)

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

Note

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

CloudWatchLogsLogGroupArn -> (string)

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

Enabled -> (boolean)

Whether the log should be published.

Status -> (structure)

The status of the log publishing options for the domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

DomainEndpointOptions -> (structure)

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

Options -> (structure)

Options to configure the endpoint for a domain.

EnforceHTTPS -> (boolean)

True to require that all traffic to the domain arrive over HTTPS.

TLSSecurityPolicy -> (string)

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

• Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
• Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
• Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

CustomEndpointEnabled -> (boolean)

Whether to enable a custom endpoint for the domain.

CustomEndpoint -> (string)

The fully qualified URL for the custom endpoint.

CustomEndpointCertificateArn -> (string)

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

Status -> (structure)

The status of the endpoint options for a domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

AdvancedSecurityOptions -> (structure)

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

Options -> (structure)

Container for fine-grained access control settings.

Enabled -> (boolean)

True if fine-grained access control is enabled.

InternalUserDatabaseEnabled -> (boolean)

True if the internal user database is enabled.

SAMLOptions -> (structure)

Container for information about the SAML configuration for OpenSearch Dashboards.

Enabled -> (boolean)

True if SAML is enabled.

Idp -> (structure)

Describes the SAML identity provider's information.

MetadataContent -> (string)

The metadata of the SAML application, in XML format.

EntityId -> (string)

The unique entity ID of the application in the SAML identity provider.

SubjectKey -> (string)

The key used for matching the SAML subject attribute.

RolesKey -> (string)

The key used for matching the SAML roles attribute.

SessionTimeoutMinutes -> (integer)

The duration, in minutes, after which a user session becomes inactive.

AnonymousAuthDisableDate -> (timestamp)

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

AnonymousAuthEnabled -> (boolean)

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

Status -> (structure)

Status of the fine-grained access control settings for a domain.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

AutoTuneOptions -> (structure)

Container for Auto-Tune settings for the domain.

Options -> (structure)

Auto-Tune settings for updating a domain.

DesiredState -> (string)

Whether Auto-Tune is enabled or disabled.

RollbackOnDisable -> (string)

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

MaintenanceSchedules -> (list)

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

(structure)

Note

This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows .

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service .

StartAt -> (timestamp)

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

Duration -> (structure)

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .

Value -> (long)

Integer to specify the value of a maintenance schedule duration.

Unit -> (string)

The unit of measurement for the duration of a maintenance schedule.

CronExpressionForRecurrence -> (string)

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

UseOffPeakWindow -> (boolean)

Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

Status -> (structure)

The current status of Auto-Tune for a domain.

CreationDate -> (timestamp)

Date and time when Auto-Tune was enabled for the domain.

UpdateDate -> (timestamp)

Date and time when the Auto-Tune options were last updated for the domain.

UpdateVersion -> (integer)

The latest version of the Auto-Tune options.

State -> (string)

The current state of Auto-Tune on the domain.

ErrorMessage -> (string)

Any errors that occurred while enabling or disabling Auto-Tune.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

ChangeProgressDetails -> (structure)

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

ChangeId -> (string)

The ID of the configuration change.

Message -> (string)

A message corresponding to the status of the configuration change.

ConfigChangeStatus -> (string)

The current status of the configuration change.

InitiatedBy -> (string)

The IAM principal who initiated the configuration change.

StartTime -> (timestamp)

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

LastUpdatedTime -> (timestamp)

The last time that the configuration change was updated.

OffPeakWindowOptions -> (structure)

Container for off-peak window options for the domain.

Options -> (structure)

The domain's off-peak window configuration.

Enabled -> (boolean)

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

OffPeakWindow -> (structure)

Off-peak window settings for the domain.

WindowStartTime -> (structure)

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

Hours -> (long)

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

Minutes -> (long)

The start minute of the window, in UTC.

Status -> (structure)

The current status of off-peak window options.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

SoftwareUpdateOptions -> (structure)

Software update options for the domain.

Options -> (structure)

The service software update options for a domain.

AutoSoftwareUpdateEnabled -> (boolean)

Whether automatic service software updates are enabled for the domain.

Status -> (structure)

The status of service software update options, including creation date and last updated date.

CreationDate -> (timestamp)

The timestamp when the entity was created.

UpdateDate -> (timestamp)

The timestamp of the last time the entity was updated.

UpdateVersion -> (integer)

The latest version of the entity.

State -> (string)

The state of the entity.

PendingDeletion -> (boolean)

Indicates whether the entity is being deleted.

ModifyingProperties -> (list)

Information about the domain properties that are currently being modified.

(structure)

Information about the domain properties that are currently being modified.

Name -> (string)

The name of the property that is currently being modified.

ActiveValue -> (string)

The current value of the domain property that is being modified.

PendingValue -> (string)

The value that the property that is currently being modified will eventually have.

ValueType -> (string)

The type of value that is currently being modified. Properties can have two types:

• PLAIN_TEXT : Contain direct values such as "1", "True", or "c5.large.search".
• STRINGIFIED_JSON : Contain content in JSON format, such as {"Enabled":"True"}".