DomainStatus

import type { DomainStatus } from "https://aws-api.deno.dev/v0.3/services/opensearch.ts?docs=full";

The current status of a domain.

interface DomainStatus {

AccessPolicies?: string | null;

AdvancedOptions?: {

[key: string]: string | null | undefined;

} | null;

AdvancedSecurityOptions?: AdvancedSecurityOptions | null;

ARN: string;

AutoTuneOptions?: AutoTuneOptionsOutput | null;

ClusterConfig: ClusterConfig;

CognitoOptions?: CognitoOptions | null;

Created?: boolean | null;

Deleted?: boolean | null;

DomainEndpointOptions?: DomainEndpointOptions | null;

DomainId: string;

DomainName: string;

EBSOptions?: EBSOptions | null;

EncryptionAtRestOptions?: EncryptionAtRestOptions | null;

Endpoint?: string | null;

Endpoints?: {

[key: string]: string | null | undefined;

} | null;

EngineVersion?: string | null;

LogPublishingOptions?: [key in LogType]: LogPublishingOption | null | undefined | null;

NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | null;

Processing?: boolean | null;

ServiceSoftwareOptions?: ServiceSoftwareOptions | null;

SnapshotOptions?: SnapshotOptions | null;

UpgradeProcessing?: boolean | null;

VPCOptions?: VPCDerivedInfo | null;

}

§Properties

AccessPolicies?: string | null

[src]

IAM access policy as a JSON-formatted string.

AdvancedOptions?: {

[key: string]: string | null | undefined;

} | null

[src]

The status of the AdvancedOptions.

AdvancedSecurityOptions?: AdvancedSecurityOptions | null

[src]

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

ARN: string

[src]

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

AutoTuneOptions?: AutoTuneOptionsOutput | null

[src]

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

ClusterConfig: ClusterConfig

[src]

The type and number of instances in the domain.

CognitoOptions?: CognitoOptions | null

[src]

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

Created?: boolean | null

[src]

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

Deleted?: boolean | null

[src]

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.

DomainEndpointOptions?: DomainEndpointOptions | null

[src]

The current status of the domain's endpoint options.

DomainId: string

[src]

The unique identifier for the specified domain.

DomainName: string

[src]

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

EBSOptions?: EBSOptions | null

[src]

The EBSOptions for the specified domain.

EncryptionAtRestOptions?: EncryptionAtRestOptions | null

[src]

The status of the EncryptionAtRestOptions.

Endpoint?: string | null

[src]

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

Endpoints?: {

[key: string]: string | null | undefined;

} | null

[src]

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'.

EngineVersion?: string | null

[src]

LogPublishingOptions?: [key in LogType]: LogPublishingOption | null | undefined | null

[src]

Log publishing options for the given domain.

NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | null

[src]

The status of the NodeToNodeEncryptionOptions.

Processing?: boolean | null

[src]

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

ServiceSoftwareOptions?: ServiceSoftwareOptions | null

[src]

The current status of the domain's service software.

SnapshotOptions?: SnapshotOptions | null

[src]

The status of the SnapshotOptions.

UpgradeProcessing?: boolean | null

[src]

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

VPCOptions?: VPCDerivedInfo | null

[src]

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