CfnDomain

class aws_cdk.aws_elasticsearch.CfnDomain(scope, id, *, access_policies=None, advanced_options=None, advanced_security_options=None, cognito_options=None, domain_endpoint_options=None, domain_name=None, ebs_options=None, elasticsearch_cluster_config=None, elasticsearch_version=None, encryption_at_rest_options=None, log_publishing_options=None, node_to_node_encryption_options=None, snapshot_options=None, tags=None, vpc_options=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Elasticsearch::Domain.

CloudformationResource

AWS::Elasticsearch::Domain

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

Create a new AWS::Elasticsearch::Domain.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Elasticsearch::Domain'
access_policies

AWS::Elasticsearch::Domain.AccessPolicies.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies

Return type

Any

advanced_options

AWS::Elasticsearch::Domain.AdvancedOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions

Return type

Union[IResolvable, Mapping[str, str], None]

advanced_security_options

AWS::Elasticsearch::Domain.AdvancedSecurityOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions

Return type

Union[IResolvable, AdvancedSecurityOptionsInputProperty, None]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_domain_endpoint

DomainEndpoint

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

cognito_options

AWS::Elasticsearch::Domain.CognitoOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions

Return type

Union[IResolvable, CognitoOptionsProperty, None]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

domain_endpoint_options

AWS::Elasticsearch::Domain.DomainEndpointOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions

Return type

Union[IResolvable, DomainEndpointOptionsProperty, None]

domain_name

AWS::Elasticsearch::Domain.DomainName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname

Return type

Optional[str]

ebs_options

AWS::Elasticsearch::Domain.EBSOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions

Return type

Union[IResolvable, EBSOptionsProperty, None]

elasticsearch_cluster_config

AWS::Elasticsearch::Domain.ElasticsearchClusterConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig

Return type

Union[IResolvable, ElasticsearchClusterConfigProperty, None]

elasticsearch_version

AWS::Elasticsearch::Domain.ElasticsearchVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion

Return type

Optional[str]

encryption_at_rest_options

AWS::Elasticsearch::Domain.EncryptionAtRestOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions

Return type

Union[IResolvable, EncryptionAtRestOptionsProperty, None]

log_publishing_options

AWS::Elasticsearch::Domain.LogPublishingOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, LogPublishingOptionProperty]], None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

node_to_node_encryption_options

AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions

Return type

Union[IResolvable, NodeToNodeEncryptionOptionsProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

snapshot_options

AWS::Elasticsearch::Domain.SnapshotOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions

Return type

Union[IResolvable, SnapshotOptionsProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::Elasticsearch::Domain.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags

Return type

TagManager

vpc_options

AWS::Elasticsearch::Domain.VPCOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions

Return type

Union[IResolvable, VPCOptionsProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AdvancedSecurityOptionsInputProperty

class CfnDomain.AdvancedSecurityOptionsInputProperty(*, enabled=None, internal_user_database_enabled=None, master_user_options=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable, None]) – CfnDomain.AdvancedSecurityOptionsInputProperty.Enabled.

  • internal_user_database_enabled (Union[bool, IResolvable, None]) – CfnDomain.AdvancedSecurityOptionsInputProperty.InternalUserDatabaseEnabled.

  • master_user_options (Union[IResolvable, MasterUserOptionsProperty, None]) – CfnDomain.AdvancedSecurityOptionsInputProperty.MasterUserOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html

Attributes

enabled

CfnDomain.AdvancedSecurityOptionsInputProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-enabled

Return type

Union[bool, IResolvable, None]

internal_user_database_enabled

CfnDomain.AdvancedSecurityOptionsInputProperty.InternalUserDatabaseEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled

Return type

Union[bool, IResolvable, None]

master_user_options

CfnDomain.AdvancedSecurityOptionsInputProperty.MasterUserOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-masteruseroptions

Return type

Union[IResolvable, MasterUserOptionsProperty, None]

CognitoOptionsProperty

class CfnDomain.CognitoOptionsProperty(*, enabled=None, identity_pool_id=None, role_arn=None, user_pool_id=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable, None]) – CfnDomain.CognitoOptionsProperty.Enabled.

  • identity_pool_id (Optional[str]) – CfnDomain.CognitoOptionsProperty.IdentityPoolId.

  • role_arn (Optional[str]) – CfnDomain.CognitoOptionsProperty.RoleArn.

  • user_pool_id (Optional[str]) – CfnDomain.CognitoOptionsProperty.UserPoolId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html

Attributes

enabled

CfnDomain.CognitoOptionsProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled

Return type

Union[bool, IResolvable, None]

identity_pool_id

CfnDomain.CognitoOptionsProperty.IdentityPoolId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid

Return type

Optional[str]

role_arn

CfnDomain.CognitoOptionsProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn

Return type

Optional[str]

user_pool_id

CfnDomain.CognitoOptionsProperty.UserPoolId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid

Return type

Optional[str]

DomainEndpointOptionsProperty

class CfnDomain.DomainEndpointOptionsProperty(*, custom_endpoint=None, custom_endpoint_certificate_arn=None, custom_endpoint_enabled=None, enforce_https=None, tls_security_policy=None)

Bases: object

Parameters
  • custom_endpoint (Optional[str]) – CfnDomain.DomainEndpointOptionsProperty.CustomEndpoint.

  • custom_endpoint_certificate_arn (Optional[str]) – CfnDomain.DomainEndpointOptionsProperty.CustomEndpointCertificateArn.

  • custom_endpoint_enabled (Union[bool, IResolvable, None]) – CfnDomain.DomainEndpointOptionsProperty.CustomEndpointEnabled.

  • enforce_https (Union[bool, IResolvable, None]) – CfnDomain.DomainEndpointOptionsProperty.EnforceHTTPS.

  • tls_security_policy (Optional[str]) – CfnDomain.DomainEndpointOptionsProperty.TLSSecurityPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html

Attributes

custom_endpoint

CfnDomain.DomainEndpointOptionsProperty.CustomEndpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpoint

Return type

Optional[str]

custom_endpoint_certificate_arn

CfnDomain.DomainEndpointOptionsProperty.CustomEndpointCertificateArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointcertificatearn

Return type

Optional[str]

custom_endpoint_enabled

CfnDomain.DomainEndpointOptionsProperty.CustomEndpointEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointenabled

Return type

Union[bool, IResolvable, None]

enforce_https

CfnDomain.DomainEndpointOptionsProperty.EnforceHTTPS.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-enforcehttps

Return type

Union[bool, IResolvable, None]

tls_security_policy

CfnDomain.DomainEndpointOptionsProperty.TLSSecurityPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-tlssecuritypolicy

Return type

Optional[str]

EBSOptionsProperty

class CfnDomain.EBSOptionsProperty(*, ebs_enabled=None, iops=None, volume_size=None, volume_type=None)

Bases: object

Parameters
  • ebs_enabled (Union[bool, IResolvable, None]) – CfnDomain.EBSOptionsProperty.EBSEnabled.

  • iops (Union[int, float, None]) – CfnDomain.EBSOptionsProperty.Iops.

  • volume_size (Union[int, float, None]) – CfnDomain.EBSOptionsProperty.VolumeSize.

  • volume_type (Optional[str]) – CfnDomain.EBSOptionsProperty.VolumeType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html

Attributes

ebs_enabled

CfnDomain.EBSOptionsProperty.EBSEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled

Return type

Union[bool, IResolvable, None]

iops

CfnDomain.EBSOptionsProperty.Iops.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops

Return type

Union[int, float, None]

volume_size

CfnDomain.EBSOptionsProperty.VolumeSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize

Return type

Union[int, float, None]

volume_type

CfnDomain.EBSOptionsProperty.VolumeType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype

Return type

Optional[str]

ElasticsearchClusterConfigProperty

class CfnDomain.ElasticsearchClusterConfigProperty(*, dedicated_master_count=None, dedicated_master_enabled=None, dedicated_master_type=None, instance_count=None, instance_type=None, warm_count=None, warm_enabled=None, warm_type=None, zone_awareness_config=None, zone_awareness_enabled=None)

Bases: object

Parameters
  • dedicated_master_count (Union[int, float, None]) – CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterCount.

  • dedicated_master_enabled (Union[bool, IResolvable, None]) – CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterEnabled.

  • dedicated_master_type (Optional[str]) – CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterType.

  • instance_count (Union[int, float, None]) – CfnDomain.ElasticsearchClusterConfigProperty.InstanceCount.

  • instance_type (Optional[str]) – CfnDomain.ElasticsearchClusterConfigProperty.InstanceType.

  • warm_count (Union[int, float, None]) – CfnDomain.ElasticsearchClusterConfigProperty.WarmCount.

  • warm_enabled (Union[bool, IResolvable, None]) – CfnDomain.ElasticsearchClusterConfigProperty.WarmEnabled.

  • warm_type (Optional[str]) – CfnDomain.ElasticsearchClusterConfigProperty.WarmType.

  • zone_awareness_config (Union[IResolvable, ZoneAwarenessConfigProperty, None]) – CfnDomain.ElasticsearchClusterConfigProperty.ZoneAwarenessConfig.

  • zone_awareness_enabled (Union[bool, IResolvable, None]) – CfnDomain.ElasticsearchClusterConfigProperty.ZoneAwarenessEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html

Attributes

dedicated_master_count

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount

Return type

Union[int, float, None]

dedicated_master_enabled

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled

Return type

Union[bool, IResolvable, None]

dedicated_master_type

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype

Return type

Optional[str]

instance_count

CfnDomain.ElasticsearchClusterConfigProperty.InstanceCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount

Return type

Union[int, float, None]

instance_type

CfnDomain.ElasticsearchClusterConfigProperty.InstanceType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype

Return type

Optional[str]

warm_count

CfnDomain.ElasticsearchClusterConfigProperty.WarmCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmcount

Return type

Union[int, float, None]

warm_enabled

CfnDomain.ElasticsearchClusterConfigProperty.WarmEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmenabled

Return type

Union[bool, IResolvable, None]

warm_type

CfnDomain.ElasticsearchClusterConfigProperty.WarmType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmtype

Return type

Optional[str]

zone_awareness_config

CfnDomain.ElasticsearchClusterConfigProperty.ZoneAwarenessConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig

Return type

Union[IResolvable, ZoneAwarenessConfigProperty, None]

zone_awareness_enabled

CfnDomain.ElasticsearchClusterConfigProperty.ZoneAwarenessEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled

Return type

Union[bool, IResolvable, None]

EncryptionAtRestOptionsProperty

class CfnDomain.EncryptionAtRestOptionsProperty(*, enabled=None, kms_key_id=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable, None]) – CfnDomain.EncryptionAtRestOptionsProperty.Enabled.

  • kms_key_id (Optional[str]) – CfnDomain.EncryptionAtRestOptionsProperty.KmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html

Attributes

enabled

CfnDomain.EncryptionAtRestOptionsProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled

Return type

Union[bool, IResolvable, None]

kms_key_id

CfnDomain.EncryptionAtRestOptionsProperty.KmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid

Return type

Optional[str]

LogPublishingOptionProperty

class CfnDomain.LogPublishingOptionProperty(*, cloud_watch_logs_log_group_arn=None, enabled=None)

Bases: object

Parameters
  • cloud_watch_logs_log_group_arn (Optional[str]) – CfnDomain.LogPublishingOptionProperty.CloudWatchLogsLogGroupArn.

  • enabled (Union[bool, IResolvable, None]) – CfnDomain.LogPublishingOptionProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html

Attributes

cloud_watch_logs_log_group_arn

CfnDomain.LogPublishingOptionProperty.CloudWatchLogsLogGroupArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-cloudwatchlogsloggrouparn

Return type

Optional[str]

enabled

CfnDomain.LogPublishingOptionProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-enabled

Return type

Union[bool, IResolvable, None]

MasterUserOptionsProperty

class CfnDomain.MasterUserOptionsProperty(*, master_user_arn=None, master_user_name=None, master_user_password=None)

Bases: object

Parameters
  • master_user_arn (Optional[str]) – CfnDomain.MasterUserOptionsProperty.MasterUserARN.

  • master_user_name (Optional[str]) – CfnDomain.MasterUserOptionsProperty.MasterUserName.

  • master_user_password (Optional[str]) – CfnDomain.MasterUserOptionsProperty.MasterUserPassword.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html

Attributes

master_user_arn

CfnDomain.MasterUserOptionsProperty.MasterUserARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserarn

Return type

Optional[str]

master_user_name

CfnDomain.MasterUserOptionsProperty.MasterUserName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masterusername

Return type

Optional[str]

master_user_password

CfnDomain.MasterUserOptionsProperty.MasterUserPassword.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserpassword

Return type

Optional[str]

NodeToNodeEncryptionOptionsProperty

class CfnDomain.NodeToNodeEncryptionOptionsProperty(*, enabled=None)

Bases: object

Parameters

enabled (Union[bool, IResolvable, None]) – CfnDomain.NodeToNodeEncryptionOptionsProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html

Attributes

enabled

CfnDomain.NodeToNodeEncryptionOptionsProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled

Return type

Union[bool, IResolvable, None]

SnapshotOptionsProperty

class CfnDomain.SnapshotOptionsProperty(*, automated_snapshot_start_hour=None)

Bases: object

Parameters

automated_snapshot_start_hour (Union[int, float, None]) – CfnDomain.SnapshotOptionsProperty.AutomatedSnapshotStartHour.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html

Attributes

automated_snapshot_start_hour

CfnDomain.SnapshotOptionsProperty.AutomatedSnapshotStartHour.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour

Return type

Union[int, float, None]

VPCOptionsProperty

class CfnDomain.VPCOptionsProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

Parameters
  • security_group_ids (Optional[Sequence[str]]) – CfnDomain.VPCOptionsProperty.SecurityGroupIds.

  • subnet_ids (Optional[Sequence[str]]) – CfnDomain.VPCOptionsProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html

Attributes

security_group_ids

CfnDomain.VPCOptionsProperty.SecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids

Return type

Optional[List[str]]

subnet_ids

CfnDomain.VPCOptionsProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids

Return type

Optional[List[str]]

ZoneAwarenessConfigProperty

class CfnDomain.ZoneAwarenessConfigProperty(*, availability_zone_count=None)

Bases: object

Parameters

availability_zone_count (Union[int, float, None]) – CfnDomain.ZoneAwarenessConfigProperty.AvailabilityZoneCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html

Attributes

availability_zone_count

CfnDomain.ZoneAwarenessConfigProperty.AvailabilityZoneCount.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount

Return type

Union[int, float, None]