VaporShell.Elasticsearch.psm1
|
# PSM1 Contents function Format-Json { [CmdletBinding()] Param ( [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [String] $Json ) Begin { $cleaner = { param([String]$Line) Process{ [Regex]::Replace( $Line, "\\u(?<Value>[a-zA-Z0-9]{4})", { param($m)([char]([int]::Parse( $m.Groups['Value'].Value, [System.Globalization.NumberStyles]::HexNumber ))).ToString() } ) } } } Process { if ($PSVersionTable.PSVersion.Major -lt 6) { try { $indent = 0; $res = $Json -split '\n' | ForEach-Object { if ($_ -match '[\}\]]') { # This line contains ] or }, decrement the indentation level $indent-- } $line = (' ' * $indent * 2) + $_.TrimStart().Replace(': ', ': ') if ($_ -match '[\{\[]') { # This line contains [ or {, increment the indentation level $indent++ } $cleaner.Invoke($line) } $res -join "`n" } catch { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } else { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } } function Get-TrueCount { Param ( [parameter(Mandatory = $false,Position = 0,ValueFromPipeline = $true)] $Array ) Process { if ($array) { if ($array.Count) { $count = $array.Count } else { $count = 1 } } else { $count = 0 } } End { return $count } } function New-VSError { <# .SYNOPSIS Error generator function to use in tandem with $PSCmdlet.ThrowTerminatingError() .PARAMETER Result Allows input of an error from AWS SDK, resulting in the Exception message being parsed out. .PARAMETER String Used to create basic String message errors in the same wrapper #> [cmdletbinding(DefaultParameterSetName="Result")] param( [parameter(Position=0,ParameterSetName="Result")] $Result, [parameter(Position=0,ParameterSetName="String")] $String ) switch ($PSCmdlet.ParameterSetName) { Result { $Exception = "$($result.Exception.InnerException.Message)" } String { $Exception = "$String" } } $e = New-Object "System.Exception" $Exception $errorRecord = New-Object 'System.Management.Automation.ErrorRecord' $e, $null, ([System.Management.Automation.ErrorCategory]::InvalidOperation), $null return $errorRecord } function ResolveS3Endpoint { <# .SYNOPSIS Resolves the S3 endpoint most appropriate for each region. #> Param ( [parameter(Mandatory=$true,Position=0)] [ValidateSet("eu-west-2","ap-south-1","us-east-2","sa-east-1","us-west-1","us-west-2","eu-west-1","ap-southeast-2","ca-central-1","ap-northeast-2","us-east-1","eu-central-1","ap-southeast-1","ap-northeast-1")] [String] $Region ) $endpointMap = @{ "us-east-2" = "s3.us-east-2.amazonaws.com" "us-east-1" = "s3.amazonaws.com" "us-west-1" = "s3-us-west-1.amazonaws.com" "us-west-2" = "s3-us-west-2.amazonaws.com" "ca-central-1" = "s3.ca-central-1.amazonaws.com" "ap-south-1" = "s3.ap-south-1.amazonaws.com" "ap-northeast-2" = "s3.ap-northeast-2.amazonaws.com" "ap-southeast-1" = "s3-ap-southeast-1.amazonaws.com" "ap-southeast-2" = "s3-ap-southeast-2.amazonaws.com" "ap-northeast-1" = "s3-ap-northeast-1.amazonaws.com" "eu-central-1" = "s3.eu-central-1.amazonaws.com" "eu-west-1" = "s3-eu-west-1.amazonaws.com" "eu-west-2" = "s3.eu-west-2.amazonaws.com" "sa-east-1" = "s3-sa-east-1.amazonaws.com" } return $endpointMap[$Region] } function Add-VSElasticsearchDomainAdvancedSecurityOptionsInput { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput resource property to the template. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html .PARAMETER Enabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-enabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER InternalUserDatabaseEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MasterUserOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-masteruseroptions Type: MasterUserOptions UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainAdvancedSecurityOptionsInput])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $InternalUserDatabaseEnabled, [parameter(Mandatory = $false)] $MasterUserOptions ) Process { $obj = [ElasticsearchDomainAdvancedSecurityOptionsInput]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainAdvancedSecurityOptionsInput' function Add-VSElasticsearchDomainCognitoOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.CognitoOptions resource property to the template. Configures Amazon ES to use Amazon Cognito authentication for Kibana. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.CognitoOptions resource property to the template. Configures Amazon ES to use Amazon Cognito authentication for Kibana. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html .PARAMETER Enabled Whether to enable or disable Amazon Cognito authentication for Kibana. See Amazon Cognito Authentication for Kibana: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IdentityPoolId The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid PrimitiveType: String UpdateType: Mutable .PARAMETER RoleArn The AmazonESCognitoAccess role that allows Amazon ES to configure your user pool and identity pool. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn PrimitiveType: String UpdateType: Mutable .PARAMETER UserPoolId The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainCognitoOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $IdentityPoolId, [parameter(Mandatory = $false)] [object] $RoleArn, [parameter(Mandatory = $false)] [object] $UserPoolId ) Process { $obj = [ElasticsearchDomainCognitoOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainCognitoOptions' function Add-VSElasticsearchDomainDomainEndpointOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.DomainEndpointOptions resource property to the template. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.DomainEndpointOptions resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html .PARAMETER CustomEndpoint Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpoint PrimitiveType: String UpdateType: Mutable .PARAMETER CustomEndpointCertificateArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointcertificatearn PrimitiveType: String UpdateType: Mutable .PARAMETER CustomEndpointEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER EnforceHTTPS Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-enforcehttps PrimitiveType: Boolean UpdateType: Mutable .PARAMETER TLSSecurityPolicy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-tlssecuritypolicy PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainDomainEndpointOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CustomEndpoint, [parameter(Mandatory = $false)] [object] $CustomEndpointCertificateArn, [parameter(Mandatory = $false)] [object] $CustomEndpointEnabled, [parameter(Mandatory = $false)] [object] $EnforceHTTPS, [parameter(Mandatory = $false)] [object] $TLSSecurityPolicy ) Process { $obj = [ElasticsearchDomainDomainEndpointOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainDomainEndpointOptions' function Add-VSElasticsearchDomainEBSOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.EBSOptions resource property to the template. The configurations of Amazon Elastic Block Store (Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.EBSOptions resource property to the template. The configurations of Amazon Elastic Block Store (Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html .PARAMETER EBSEnabled Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Iops The number of I/O operations per second IOPS that the volume supports. This property applies only to the Provisioned IOPS SSD EBS volume type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeSize The size in GiB of the EBS volume for each data node. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize PrimitiveType: Integer UpdateType: Mutable .PARAMETER VolumeType The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1, st1, or sc1. For more information about each type, see Amazon EBS Volume Types: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html in the *Amazon EC2 User Guide for Linux Instances*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainEBSOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $EBSEnabled, [parameter(Mandatory = $false)] [object] $Iops, [parameter(Mandatory = $false)] [object] $VolumeSize, [parameter(Mandatory = $false)] [object] $VolumeType ) Process { $obj = [ElasticsearchDomainEBSOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainEBSOptions' function Add-VSElasticsearchDomainElasticsearchClusterConfig { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.ElasticsearchClusterConfig resource property to the template. The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see Configuring Amazon ES Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains-configure-cluster-cli in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.ElasticsearchClusterConfig resource property to the template. The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see Configuring Amazon ES Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains-configure-cluster-cli in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html .PARAMETER DedicatedMasterCount The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount PrimitiveType: Integer UpdateType: Mutable .PARAMETER DedicatedMasterEnabled Indicates whether to use a dedicated master node for the Amazon ES domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER DedicatedMasterType The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.elasticsearch. If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported Instance Types: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype PrimitiveType: String UpdateType: Mutable .PARAMETER InstanceCount The number of data nodes instances to use in the Amazon ES domain. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount PrimitiveType: Integer UpdateType: Mutable .PARAMETER InstanceType The instance type for your data nodes, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-supported-instance-types.html in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype PrimitiveType: String UpdateType: Mutable .PARAMETER WarmCount *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmcount PrimitiveType: Integer UpdateType: Mutable .PARAMETER WarmEnabled *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER WarmType *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmtype PrimitiveType: String UpdateType: Mutable .PARAMETER ZoneAwarenessConfig Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig Type: ZoneAwarenessConfig UpdateType: Mutable .PARAMETER ZoneAwarenessEnabled Indicates whether to enable zone awareness for the Amazon ES domain. When you enable zone awareness, Amazon ES allocates the nodes and replica index shards that belong to a cluster across two Availability Zones AZs in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Enabling Zone Awareness: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainElasticsearchClusterConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DedicatedMasterCount, [parameter(Mandatory = $false)] [object] $DedicatedMasterEnabled, [parameter(Mandatory = $false)] [object] $DedicatedMasterType, [parameter(Mandatory = $false)] [object] $InstanceCount, [parameter(Mandatory = $false)] [object] $InstanceType, [parameter(Mandatory = $false)] [object] $WarmCount, [parameter(Mandatory = $false)] [object] $WarmEnabled, [parameter(Mandatory = $false)] [object] $WarmType, [parameter(Mandatory = $false)] $ZoneAwarenessConfig, [parameter(Mandatory = $false)] [object] $ZoneAwarenessEnabled ) Process { $obj = [ElasticsearchDomainElasticsearchClusterConfig]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainElasticsearchClusterConfig' function Add-VSElasticsearchDomainEncryptionAtRestOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.EncryptionAtRestOptions resource property to the template. Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS key to use. Can only be used to create a new domain, not update an existing one. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.EncryptionAtRestOptions resource property to the template. Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS key to use. Can only be used to create a new domain, not update an existing one. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html .PARAMETER Enabled Specify true to enable encryption at rest. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled PrimitiveType: Boolean UpdateType: Conditional .PARAMETER KmsKeyId The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid PrimitiveType: String UpdateType: Immutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainEncryptionAtRestOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled, [parameter(Mandatory = $false)] [object] $KmsKeyId ) Process { $obj = [ElasticsearchDomainEncryptionAtRestOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainEncryptionAtRestOptions' function Add-VSElasticsearchDomainLogPublishingOption { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.LogPublishingOption resource property to the template. Specifies whether the Amazon ES domain publishes the Elasticsearch application and slow logs to Amazon CloudWatch. You still have to enable the *collection* of slow logs using the Elasticsearch REST API. To learn more, see Setting Elasticsearch Logging Thresholds for Slow Logs: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-slow-logs-indices. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.LogPublishingOption resource property to the template. Specifies whether the Amazon ES domain publishes the Elasticsearch application and slow logs to Amazon CloudWatch. You still have to enable the *collection* of slow logs using the Elasticsearch REST API. To learn more, see Setting Elasticsearch Logging Thresholds for Slow Logs: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-slow-logs-indices. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html .PARAMETER CloudWatchLogsLogGroupArn Specifies the CloudWatch log group to publish to. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-cloudwatchlogsloggrouparn PrimitiveType: String UpdateType: Mutable .PARAMETER Enabled If true, enables the publishing of logs to CloudWatch. Default: false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-enabled PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainLogPublishingOption])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CloudWatchLogsLogGroupArn, [parameter(Mandatory = $false)] [object] $Enabled ) Process { $obj = [ElasticsearchDomainLogPublishingOption]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainLogPublishingOption' function Add-VSElasticsearchDomainMasterUserOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.MasterUserOptions resource property to the template. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.MasterUserOptions resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html .PARAMETER MasterUserARN Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserarn PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUserName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masterusername PrimitiveType: String UpdateType: Mutable .PARAMETER MasterUserPassword Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserpassword PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainMasterUserOptions])] [cmdletbinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","MasterUserPassword")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPasswordParams","MasterUserPassword")] Param( [parameter(Mandatory = $false)] [object] $MasterUserARN, [parameter(Mandatory = $false)] [object] $MasterUserName, [parameter(Mandatory = $false)] [object] $MasterUserPassword ) Process { $obj = [ElasticsearchDomainMasterUserOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainMasterUserOptions' function Add-VSElasticsearchDomainNodeToNodeEncryptionOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions resource property to the template. Specifies whether node-to-node encryption is enabled. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions resource property to the template. Specifies whether node-to-node encryption is enabled. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html .PARAMETER Enabled Specifies whether node-to-node encryption is enabled, as a Boolean. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled PrimitiveType: Boolean UpdateType: Conditional .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainNodeToNodeEncryptionOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Enabled ) Process { $obj = [ElasticsearchDomainNodeToNodeEncryptionOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainNodeToNodeEncryptionOptions' function Add-VSElasticsearchDomainSnapshotOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.SnapshotOptions resource property to the template. The automated snapshot configuration for the Amazon ES domain indices. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.SnapshotOptions resource property to the template. The automated snapshot configuration for the Amazon ES domain indices. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html .PARAMETER AutomatedSnapshotStartHour The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain. For example, if you specify 0, Amazon ES takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainSnapshotOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AutomatedSnapshotStartHour ) Process { $obj = [ElasticsearchDomainSnapshotOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainSnapshotOptions' function Add-VSElasticsearchDomainVPCOptions { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.VPCOptions resource property to the template. The virtual private cloud (VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.VPCOptions resource property to the template. The virtual private cloud (VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html .PARAMETER SecurityGroupIds The list of security group IDs that are associated with the VPC endpoints for the domain. If you don't provide a security group ID, Amazon ES uses the default security group for the VPC. To learn more, see Security Groups for your VPC : https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.htmlin the *Amazon VPC User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER SubnetIds Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainVPCOptions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $SecurityGroupIds, [parameter(Mandatory = $false)] $SubnetIds ) Process { $obj = [ElasticsearchDomainVPCOptions]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainVPCOptions' function Add-VSElasticsearchDomainZoneAwarenessConfig { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. .DESCRIPTION Adds an AWS::Elasticsearch::Domain.ZoneAwarenessConfig resource property to the template. Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html .PARAMETER AvailabilityZoneCount If you enabled multiple Availability Zones AZs, the number of AZs that you want the domain to use. Valid values are 2 and 3. Default is 2. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomainZoneAwarenessConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AvailabilityZoneCount ) Process { $obj = [ElasticsearchDomainZoneAwarenessConfig]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSElasticsearchDomainZoneAwarenessConfig' function New-VSElasticsearchDomain { <# .SYNOPSIS Adds an AWS::Elasticsearch::Domain resource to the template. The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES domain that encapsulates the Amazon ES engine instances. .DESCRIPTION Adds an AWS::Elasticsearch::Domain resource to the template. The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service (Amazon ES domain that encapsulates the Amazon ES engine instances. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER AccessPolicies An AWS Identity and Access Management IAM policy document that specifies who can access the Amazon ES domain and their permissions. For more information, see Configuring Access Policies : https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policiesin the *Amazon Elasticsearch Service Developer Guid*e. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies PrimitiveType: Json UpdateType: Mutable .PARAMETER AdvancedOptions Additional options to specify for the Amazon ES domain. For more information, see Configuring Advanced Options: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions DuplicatesAllowed: False PrimitiveItemType: String Type: Map UpdateType: Mutable .PARAMETER AdvancedSecurityOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions Type: AdvancedSecurityOptionsInput UpdateType: Immutable .PARAMETER CognitoOptions Configures Amazon ES to use Amazon Cognito authentication for Kibana. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions Type: CognitoOptions UpdateType: Mutable .PARAMETER DomainEndpointOptions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions Type: DomainEndpointOptions UpdateType: Mutable .PARAMETER DomainName A name for the Amazon ES domain. For valid values, see the DomainName: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-domainname data type in the *Amazon Elasticsearch Service Developer Guide*. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname PrimitiveType: String UpdateType: Immutable .PARAMETER EBSOptions The configurations of Amazon Elastic Block Store Amazon EBS volumes that are attached to data nodes in the Amazon ES domain. For more information, see Configuring EBS-based Storage: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions Type: EBSOptions UpdateType: Mutable .PARAMETER ElasticsearchClusterConfig ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon Elasticsearch Service Amazon ES domain. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig Type: ElasticsearchClusterConfig UpdateType: Mutable .PARAMETER ElasticsearchVersion The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that Amazon ES supports, see the Elasticsearch-Version parameter for the CreateElasticsearchDomain: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-actions-createelasticsearchdomain action in the *Amazon Elasticsearch Service Developer Guide*. If you set the UpgradeElasticsearchVersion: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeelasticsearchversion update policy to true, you can update ElasticsearchVersion without interruption. When UpgradeElasticsearchVersion is set to false, or is not specified, updating ElasticsearchVersion results in replacement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion PrimitiveType: String UpdateType: Conditional .PARAMETER EncryptionAtRestOptions Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service KMS key to use. Can only be used to create a new domain, not update an existing one. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions Type: EncryptionAtRestOptions UpdateType: Conditional .PARAMETER LogPublishingOptions Key-value pairs to configure slow log publishing. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions DuplicatesAllowed: False ItemType: LogPublishingOption Type: Map UpdateType: Mutable .PARAMETER NodeToNodeEncryptionOptions Specifies whether node-to-node encryption is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions Type: NodeToNodeEncryptionOptions UpdateType: Conditional .PARAMETER SnapshotOptions The automated snapshot configuration for the Amazon ES domain indices. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions Type: SnapshotOptions UpdateType: Mutable .PARAMETER Tags An arbitrary set of tags key–value pairs to associate with the Amazon ES domain. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags DuplicatesAllowed: True ItemType: Tag Type: List UpdateType: Mutable .PARAMETER VPCOptions The virtual private cloud VPC configuration for the Amazon ES domain. For more information, see VPC Support for Amazon Elasticsearch Service Domains: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html in the *Amazon Elasticsearch Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions Type: VPCOptions UpdateType: Mutable .PARAMETER DeletionPolicy 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. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn 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. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata 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 or YAML 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. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([ElasticsearchDomain])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [VSJson] $AccessPolicies, [parameter(Mandatory = $false)] [IDictionary] $AdvancedOptions, [parameter(Mandatory = $false)] $AdvancedSecurityOptions, [parameter(Mandatory = $false)] $CognitoOptions, [parameter(Mandatory = $false)] $DomainEndpointOptions, [parameter(Mandatory = $false)] [object] $DomainName, [parameter(Mandatory = $false)] $EBSOptions, [parameter(Mandatory = $false)] $ElasticsearchClusterConfig, [parameter(Mandatory = $false)] [object] $ElasticsearchVersion, [parameter(Mandatory = $false)] $EncryptionAtRestOptions, [parameter(Mandatory = $false)] [object] $LogPublishingOptions, [parameter(Mandatory = $false)] $NodeToNodeEncryptionOptions, [parameter(Mandatory = $false)] $SnapshotOptions, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] $VPCOptions, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [ElasticsearchDomain]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSElasticsearchDomain' |