< Back
Add-CfnElasticsearch_DomainResource
Post
NAME Add-CfnElasticsearch_DomainResource
SYNOPSIS
The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES) domain that
encapsulates the Amazon ES engine instances.
SYNTAX
Add-CfnElasticsearch_DomainResource [-ResourceName] <String> [-AccessPolicies <Object>] [-AdvancedOptions
<Object>] [-DomainName <String>] [-EBSOptions <IDictionary>] [-ElasticsearchClusterConfig <IDictionary>]
[-SnapshotOptions <IDictionary>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata <Hashtable>]
[-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessPolicies <Object>
An AWS Identity and Access Management (IAM) policy document that specifies who can access the Amazon ES domain
and their permissions.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AdvancedOptions <Object>
Additional options to specify for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DomainName <String>
A name for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EBSOptions <IDictionary>
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the
Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ElasticsearchClusterConfig <IDictionary>
The cluster configuration for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotOptions <IDictionary>
The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES
domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... ch::Domain
SYNOPSIS
The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES) domain that
encapsulates the Amazon ES engine instances.
SYNTAX
Add-CfnElasticsearch_DomainResource [-ResourceName] <String> [-AccessPolicies <Object>] [-AdvancedOptions
<Object>] [-DomainName <String>] [-EBSOptions <IDictionary>] [-ElasticsearchClusterConfig <IDictionary>]
[-SnapshotOptions <IDictionary>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata <Hashtable>]
[-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessPolicies <Object>
An AWS Identity and Access Management (IAM) policy document that specifies who can access the Amazon ES domain
and their permissions.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AdvancedOptions <Object>
Additional options to specify for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DomainName <String>
A name for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EBSOptions <IDictionary>
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the
Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ElasticsearchClusterConfig <IDictionary>
The cluster configuration for the Amazon ES domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotOptions <IDictionary>
The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES
domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... ch::Domain