[ aws . opensearch ]

delete-domain

Description

Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--domain-name (string)

The name of the domain you want to permanently delete.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

DomainStatus -> (structure)

The status of the domain being deleted.

DomainId -> (string)

The unique identifier for the specified domain.

DomainName -> (string)

The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

ARN -> (string)

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

Created -> (boolean)

The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

Deleted -> (boolean)

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Endpoint -> (string)

The domain endpoint that you use to submit index and search requests.

Endpoints -> (map)

Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

key -> (string)

value -> (string)

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .

Processing -> (boolean)

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

UpgradeProcessing -> (boolean)

The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

EngineVersion -> (string)

ClusterConfig -> (structure)

The type and number of instances in the 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

EBSOptions -> (structure)

The EBSOptions 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 IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

Throughput -> (integer)

The Throughput for GP3 EBS volume (SSD).

AccessPolicies -> (string)

IAM access policy as a JSON-formatted string.

SnapshotOptions -> (structure)

The status of the SnapshotOptions .

AutomatedSnapshotStartHour -> (integer)

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

VPCOptions -> (structure)

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

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)

CognitoOptions -> (structure)

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

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.

EncryptionAtRestOptions -> (structure)

The status of the EncryptionAtRestOptions .

Enabled -> (boolean)

The option to enable encryption at rest.

KmsKeyId -> (string)

The KMS key ID for encryption at rest options.

NodeToNodeEncryptionOptions -> (structure)

The status of the NodeToNodeEncryptionOptions .

Enabled -> (boolean)

True to enable node-to-node encryption.

AdvancedOptions -> (map)

The status of the AdvancedOptions .

key -> (string)

value -> (string)

LogPublishingOptions -> (map)

Log publishing options for the given 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.

ServiceSoftwareOptions -> (structure)

The current status of the domain’s service software.

CurrentVersion -> (string)

The current service software version present on the domain.

NewVersion -> (string)

The new service software version if one is available.

UpdateAvailable -> (boolean)

True if you’re able to update your service software version. False if you can’t update your service software version.

Cancellable -> (boolean)

True if you’re able to cancel your service software version update. False if you can’t cancel your service software update.

UpdateStatus -> (string)

The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

Description -> (string)

The description of the UpdateStatus .

AutomatedUpdateDate -> (timestamp)

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

OptionalDeployment -> (boolean)

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .

DomainEndpointOptions -> (structure)

The current status of the domain’s endpoint options.

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.

AdvancedSecurityOptions -> (structure)

The current status of the domain’s advanced security options.

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.

AutoTuneOptions -> (structure)

The current status of the domain’s Auto-Tune options.

State -> (string)

The AutoTuneState for the domain.

ErrorMessage -> (string)

The error message while enabling or disabling Auto-Tune.

ChangeProgressDetails -> (structure)

Specifies change details of the domain configuration change.

ChangeId -> (string)

The unique change identifier associated with a specific domain configuration change.

Message -> (string)

Contains an optional message associated with the domain configuration change.