[ aws . opensearch ]

describe-domain-config

Description

Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-domain-config
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The domain you want to get information about.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DomainConfig -> (structure)

The configuration information of the domain requested in the DescribeDomainConfig request.

EngineVersion -> (structure)

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

Options -> (string)

The OpenSearch version for the specified OpenSearch domain.

Status -> (structure)

The status of the OpenSearch version options for the specified OpenSearch domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

ClusterConfig -> (structure)

The ClusterConfig for the domain.

Options -> (structure)

The cluster configuration for the specified domain.

InstanceType -> (string)

The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

InstanceCount -> (integer)

The number of instances in the specified domain cluster.

DedicatedMasterEnabled -> (boolean)

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

ZoneAwarenessEnabled -> (boolean)

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

ZoneAwarenessConfig -> (structure)

The zone awareness configuration for a domain when zone awareness is enabled.

AvailabilityZoneCount -> (integer)

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

DedicatedMasterType -> (string)

The instance type for a dedicated master node.

DedicatedMasterCount -> (integer)

Total number of dedicated master nodes, active and on standby, for the cluster.

WarmEnabled -> (boolean)

True to enable UltraWarm storage.

WarmType -> (string)

The instance type for the OpenSearch cluster’s warm nodes.

WarmCount -> (integer)

The number of UltraWarm nodes in the cluster.

ColdStorageOptions -> (structure)

Specifies the ColdStorageOptions config for a Domain

Enabled -> (boolean)

Enable cold storage option. Accepted values true or false

Status -> (structure)

The cluster configuration status for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

EBSOptions -> (structure)

The EBSOptions for the domain.

Options -> (structure)

The EBS options for the specified domain.

EBSEnabled -> (boolean)

Whether EBS-based storage is enabled.

VolumeType -> (string)

The volume type for EBS-based storage.

VolumeSize -> (integer)

Integer to specify the size of an EBS volume.

Iops -> (integer)

The IOPD for a Provisioned IOPS EBS volume (SSD).

Status -> (structure)

The status of the EBS options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

AccessPolicies -> (structure)

IAM access policy as a JSON-formatted string.

Options -> (string)

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

Status -> (structure)

The status of the access policy for the domain. See OptionStatus for the status information that’s included.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

SnapshotOptions -> (structure)

The SnapshotOptions for the domain.

Options -> (structure)

The daily snapshot options specified for the domain.

AutomatedSnapshotStartHour -> (integer)

The time, in UTC format, when the 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 of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

VPCOptions -> (structure)

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

Options -> (structure)

The VPC options for the specified domain.

VPCId -> (string)

The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

SubnetIds -> (list)

The subnets for the VPC endpoint.

(string)

AvailabilityZones -> (list)

The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

(string)

SecurityGroupIds -> (list)

The security groups for the VPC endpoint.

(string)

Status -> (structure)

The status of the VPC options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

CognitoOptions -> (structure)

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

Options -> (structure)

Cognito options for the specified domain.

Enabled -> (boolean)

The option to enable Cognito for OpenSearch Dashboards authentication.

UserPoolId -> (string)

The Cognito user pool ID for OpenSearch Dashboards authentication.

IdentityPoolId -> (string)

The Cognito identity pool ID for OpenSearch Dashboards authentication.

RoleArn -> (string)

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

Status -> (structure)

The status of the Cognito options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

EncryptionAtRestOptions -> (structure)

The EncryptionAtRestOptions for the domain.

Options -> (structure)

The Encryption At Rest options for the specified domain.

Enabled -> (boolean)

The option to enable encryption at rest.

KmsKeyId -> (string)

The KMS key ID for encryption at rest options.

Status -> (structure)

The status of the Encryption At Rest options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

NodeToNodeEncryptionOptions -> (structure)

The NodeToNodeEncryptionOptions for the domain.

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 of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

AdvancedOptions -> (structure)

The AdvancedOptions for the domain. See Advanced options for more information.

Options -> (map)

The status of advanced options for the specified domain.

key -> (string)

value -> (string)

Status -> (structure)

The OptionStatus for advanced options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

LogPublishingOptions -> (structure)

Log publishing options for the given domain.

Options -> (map)

The log publishing options configured for the domain.

key -> (string)

Type of log file. Can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.

  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than 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 from the domain.

value -> (structure)

Log Publishing option that is set for a given domain. Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.

  • Enabled: Whether the log publishing for a given log type is enabled or not.

CloudWatchLogsLogGroupArn -> (string)

ARN of the Cloudwatch log group to publish logs to.

Enabled -> (boolean)

Whether the given log publishing option is enabled or not.

Status -> (structure)

The status of the log publishing options for the domain. See OptionStatus for the status information that’s included.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

DomainEndpointOptions -> (structure)

The DomainEndpointOptions for the domain.

Options -> (structure)

Options to configure the endpoint for the domain.

EnforceHTTPS -> (boolean)

Whether only HTTPS endpoint should be enabled for the domain.

TLSSecurityPolicy -> (string)

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

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.

  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

CustomEndpointEnabled -> (boolean)

Whether to enable a custom endpoint for the domain.

CustomEndpoint -> (string)

The fully qualified domain for your custom endpoint.

CustomEndpointCertificateArn -> (string)

The ACM certificate ARN for your custom endpoint.

Status -> (structure)

The status of the endpoint options for the domain. See OptionStatus for the status information that’s included.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

AdvancedSecurityOptions -> (structure)

Specifies AdvancedSecurityOptions for the domain.

Options -> (structure)

Advanced security options for the specified domain.

Enabled -> (boolean)

True if advanced security is enabled.

InternalUserDatabaseEnabled -> (boolean)

True if the internal user database is enabled.

SAMLOptions -> (structure)

Describes the SAML application configured for a domain.

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 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)

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

AnonymousAuthEnabled -> (boolean)

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

Status -> (structure)

Status of the advanced security options for the specified domain.

CreationDate -> (timestamp)

The timestamp of 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)

Provides the OptionState for the domain.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.

AutoTuneOptions -> (structure)

Specifies AutoTuneOptions for the domain.

Options -> (structure)

Specifies Auto-Tune options for the domain.

DesiredState -> (string)

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

RollbackOnDisable -> (string)

The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

MaintenanceSchedules -> (list)

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

(structure)

Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

StartAt -> (timestamp)

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

Duration -> (structure)

Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.

Value -> (long)

Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.

Unit -> (string)

The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.

CronExpressionForRecurrence -> (string)

A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

Status -> (structure)

The status of the Auto-Tune options for the domain.

CreationDate -> (timestamp)

The timestamp of the Auto-Tune options creation date.

UpdateDate -> (timestamp)

The timestamp of when the Auto-Tune options were last updated.

UpdateVersion -> (integer)

The latest version of the Auto-Tune options.

State -> (string)

The AutoTuneState for the domain.

ErrorMessage -> (string)

The error message while enabling or disabling Auto-Tune.

PendingDeletion -> (boolean)

Indicates whether the domain is being deleted.