Skip to content

AwsElasticsearchDomainDetails

Source code in docs_src/capo_securityhub/types/aws_elasticsearch_domain_details.py
class AwsElasticsearchDomainDetails(TypedDict, closed=True):
    access_policies: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>IAM policy document specifying the access policies for the new Elasticsearch domain.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_domain_endpoint_options.AwsElasticsearchDomainDomainEndpointOptions"
    ]
    """<p>Additional options for the domain endpoint.</p>"""
    domain_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Unique identifier for an Elasticsearch domain.</p>"""
    domain_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Name of an Elasticsearch domain.</p> <p>Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.</p> <p>Domain names must start with a lowercase letter and must be between 3 and 28 characters.</p> <p>Valid characters are a-z (lowercase only), 0-9, and – (hyphen). </p>"""
    endpoint: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.</p> <p>The endpoint is a service URL. </p>"""
    endpoints: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.</p>"""
    elasticsearch_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>OpenSearch version.</p>"""
    elasticsearch_cluster_config: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_elasticsearch_cluster_config_details.AwsElasticsearchDomainElasticsearchClusterConfigDetails"
    ]
    """<p>Information about an OpenSearch cluster configuration.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_encryption_at_rest_options.AwsElasticsearchDomainEncryptionAtRestOptions"
    ]
    """<p>Details about the configuration for encryption at rest.</p>"""
    log_publishing_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_log_publishing_options.AwsElasticsearchDomainLogPublishingOptions"
    ]
    """<p>Configures the CloudWatch Logs to publish for the Elasticsearch domain.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_node_to_node_encryption_options.AwsElasticsearchDomainNodeToNodeEncryptionOptions"
    ]
    """<p>Details about the configuration for node-to-node encryption.</p>"""
    service_software_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_service_software_options.AwsElasticsearchDomainServiceSoftwareOptions"
    ]
    """<p>Information about the status of a domain relative to the latest service software.</p>"""
    vpc_options: NotRequired[
        "capo_securityhub.types.aws_elasticsearch_domain_vpc_options.AwsElasticsearchDomainVPCOptions"
    ]
    """<p>Information that OpenSearch derives based on <code>VPCOptions</code> for the domain.</p>"""

access_policies instance-attribute

access_policies: NotRequired[NonEmptyString]

IAM policy document specifying the access policies for the new Elasticsearch domain.

domain_endpoint_options instance-attribute

domain_endpoint_options: NotRequired[AwsElasticsearchDomainDomainEndpointOptions]

Additional options for the domain endpoint.

domain_id instance-attribute

domain_id: NotRequired[NonEmptyString]

Unique identifier for an Elasticsearch domain.

domain_name instance-attribute

domain_name: NotRequired[NonEmptyString]

Name of an Elasticsearch domain.

Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

elasticsearch_cluster_config instance-attribute

elasticsearch_cluster_config: NotRequired[
    AwsElasticsearchDomainElasticsearchClusterConfigDetails
]

Information about an OpenSearch cluster configuration.

elasticsearch_version instance-attribute

elasticsearch_version: NotRequired[NonEmptyString]

OpenSearch version.

encryption_at_rest_options instance-attribute

encryption_at_rest_options: NotRequired[AwsElasticsearchDomainEncryptionAtRestOptions]

Details about the configuration for encryption at rest.

endpoint instance-attribute

endpoint: NotRequired[NonEmptyString]

Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.

The endpoint is a service URL.

endpoints instance-attribute

endpoints: NotRequired[FieldMap]

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

log_publishing_options instance-attribute

log_publishing_options: NotRequired[AwsElasticsearchDomainLogPublishingOptions]

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

node_to_node_encryption_options instance-attribute

node_to_node_encryption_options: NotRequired[
    AwsElasticsearchDomainNodeToNodeEncryptionOptions
]

Details about the configuration for node-to-node encryption.

service_software_options instance-attribute

service_software_options: NotRequired[AwsElasticsearchDomainServiceSoftwareOptions]

Information about the status of a domain relative to the latest service software.

vpc_options instance-attribute

vpc_options: NotRequired[AwsElasticsearchDomainVPCOptions]

Information that OpenSearch derives based on VPCOptions for the domain.