The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::ES::ElasticsearchDomainStatus

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ES::ElasticsearchDomainStatus object:

  $service_obj->Method(Att1 => { AccessPolicies => $value, ..., VPCOptions => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ES::ElasticsearchDomainStatus object:

  $result = $service_obj->Method(...);
  $result->Att1->AccessPolicies

DESCRIPTION

The current status of an Elasticsearch domain.

ATTRIBUTES

AccessPolicies => Str

  IAM access policy as a JSON-formatted string.

AdvancedOptions => Paws::ES::AdvancedOptions

  Specifies the status of the C<AdvancedOptions>

REQUIRED ARN => Str

  The Amazon resource name (ARN) of an Elasticsearch domain. See
Identifiers for IAM Entities
(http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
in I<Using AWS Identity and Access Management> for more information.

CognitoOptions => Paws::ES::CognitoOptions

  The C<CognitoOptions> for the specified domain. For more information,
see Amazon Cognito Authentication for Kibana
(http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).

Created => Bool

  The domain creation status. C<True> if the creation of an Elasticsearch
domain is complete. C<False> if domain creation is still in progress.

Deleted => Bool

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

REQUIRED DomainId => Str

  The unique identifier for the specified Elasticsearch domain.

REQUIRED DomainName => Str

  The name of an Elasticsearch 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 => Paws::ES::EBSOptions

  The C<EBSOptions> for the specified domain. See Configuring EBS-based
Storage
(http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)
for more information.

REQUIRED ElasticsearchClusterConfig => Paws::ES::ElasticsearchClusterConfig

  The type and number of instances in the domain cluster.

ElasticsearchVersion => Str

EncryptionAtRestOptions => Paws::ES::EncryptionAtRestOptions

  Specifies the status of the C<EncryptionAtRestOptions>.

Endpoint => Str

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

Endpoints => Paws::ES::EndpointsMap

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

LogPublishingOptions => Paws::ES::LogPublishingOptions

  Log publishing options for the given domain.

NodeToNodeEncryptionOptions => Paws::ES::NodeToNodeEncryptionOptions

  Specifies the status of the C<NodeToNodeEncryptionOptions>.

Processing => Bool

  The status of the Elasticsearch domain configuration. C<True> if Amazon
Elasticsearch Service is processing configuration changes. C<False> if
the configuration is active.

ServiceSoftwareOptions => Paws::ES::ServiceSoftwareOptions

  The current status of the Elasticsearch domain's service software.

SnapshotOptions => Paws::ES::SnapshotOptions

  Specifies the status of the C<SnapshotOptions>

UpgradeProcessing => Bool

  The status of an Elasticsearch domain version upgrade. C<True> if
Amazon Elasticsearch Service is undergoing a version upgrade. C<False>
if the configuration is active.

VPCOptions => Paws::ES::VPCDerivedInfo

  The C<VPCOptions> for the specified domain. For more information, see
VPC Endpoints for Amazon Elasticsearch Service Domains
(http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ES

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues