VaporShell.ECS.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-VSECSCapacityProviderAutoScalingGroupProvider { <# .SYNOPSIS Adds an AWS::ECS::CapacityProvider.AutoScalingGroupProvider resource property to the template. .DESCRIPTION Adds an AWS::ECS::CapacityProvider.AutoScalingGroupProvider resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html .PARAMETER AutoScalingGroupArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-autoscalinggrouparn UpdateType: Immutable PrimitiveType: String .PARAMETER ManagedScaling Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedscaling UpdateType: Immutable Type: ManagedScaling .PARAMETER ManagedTerminationProtection Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedterminationprotection UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSCapacityProviderAutoScalingGroupProvider])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $AutoScalingGroupArn, [parameter(Mandatory = $false)] $ManagedScaling, [parameter(Mandatory = $false)] [object] $ManagedTerminationProtection ) Process { $obj = [ECSCapacityProviderAutoScalingGroupProvider]::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-VSECSCapacityProviderAutoScalingGroupProvider' function Add-VSECSCapacityProviderManagedScaling { <# .SYNOPSIS Adds an AWS::ECS::CapacityProvider.ManagedScaling resource property to the template. .DESCRIPTION Adds an AWS::ECS::CapacityProvider.ManagedScaling resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html .PARAMETER MinimumScalingStepSize Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-minimumscalingstepsize UpdateType: Immutable PrimitiveType: Integer .PARAMETER MaximumScalingStepSize Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-maximumscalingstepsize UpdateType: Immutable PrimitiveType: Integer .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-status UpdateType: Immutable PrimitiveType: String .PARAMETER TargetCapacity Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-targetcapacity UpdateType: Immutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSCapacityProviderManagedScaling])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $MinimumScalingStepSize, [parameter(Mandatory = $false)] [object] $MaximumScalingStepSize, [parameter(Mandatory = $false)] [object] $Status, [parameter(Mandatory = $false)] [object] $TargetCapacity ) Process { $obj = [ECSCapacityProviderManagedScaling]::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-VSECSCapacityProviderManagedScaling' function Add-VSECSClusterCapacityProviderStrategyItem { <# .SYNOPSIS Adds an AWS::ECS::Cluster.CapacityProviderStrategyItem resource property to the template. .DESCRIPTION Adds an AWS::ECS::Cluster.CapacityProviderStrategyItem resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html .PARAMETER CapacityProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider UpdateType: Mutable PrimitiveType: String .PARAMETER Weight Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-weight UpdateType: Mutable PrimitiveType: Integer .PARAMETER Base Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterCapacityProviderStrategyItem])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CapacityProvider, [parameter(Mandatory = $false)] [object] $Weight, [parameter(Mandatory = $false)] [object] $Base ) Process { $obj = [ECSClusterCapacityProviderStrategyItem]::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-VSECSClusterCapacityProviderStrategyItem' function Add-VSECSClusterClusterConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Cluster.ClusterConfiguration resource property to the template. .DESCRIPTION Adds an AWS::ECS::Cluster.ClusterConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html .PARAMETER ExecuteCommandConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-executecommandconfiguration UpdateType: Mutable Type: ExecuteCommandConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterClusterConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ExecuteCommandConfiguration ) Process { $obj = [ECSClusterClusterConfiguration]::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-VSECSClusterClusterConfiguration' function Add-VSECSClusterClusterSetting { <# .SYNOPSIS Adds an AWS::ECS::Cluster.ClusterSetting resource property to the template. The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. .DESCRIPTION Adds an AWS::ECS::Cluster.ClusterSetting resource property to the template. The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html .PARAMETER Name The name of the cluster setting. The only supported value is containerInsights. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html#cfn-ecs-cluster-clustersetting-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html or PutAccountSettingDefault: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersetting.html#cfn-ecs-cluster-clustersetting-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterClusterSetting])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $Value ) Process { $obj = [ECSClusterClusterSetting]::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-VSECSClusterClusterSetting' function Add-VSECSClusterClusterSettings { <# .SYNOPSIS Adds an AWS::ECS::Cluster.ClusterSettings resource property to the template. .DESCRIPTION Adds an AWS::ECS::Cluster.ClusterSettings resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html .PARAMETER Name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-name UpdateType: Mutable PrimitiveType: String .PARAMETER Value Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-value UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterClusterSettings])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ECSClusterClusterSettings]::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-VSECSClusterClusterSettings' function Add-VSECSClusterExecuteCommandConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Cluster.ExecuteCommandConfiguration resource property to the template. .DESCRIPTION Adds an AWS::ECS::Cluster.ExecuteCommandConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html .PARAMETER KmsKeyId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-kmskeyid UpdateType: Mutable PrimitiveType: String .PARAMETER Logging Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging UpdateType: Mutable PrimitiveType: String .PARAMETER LogConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logconfiguration UpdateType: Mutable Type: ExecuteCommandLogConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterExecuteCommandConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $KmsKeyId, [parameter(Mandatory = $false)] [object] $Logging, [parameter(Mandatory = $false)] $LogConfiguration ) Process { $obj = [ECSClusterExecuteCommandConfiguration]::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-VSECSClusterExecuteCommandConfiguration' function Add-VSECSClusterExecuteCommandLogConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Cluster.ExecuteCommandLogConfiguration resource property to the template. .DESCRIPTION Adds an AWS::ECS::Cluster.ExecuteCommandLogConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html .PARAMETER CloudWatchLogGroupName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchloggroupname UpdateType: Mutable PrimitiveType: String .PARAMETER CloudWatchEncryptionEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchencryptionenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER S3BucketName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3bucketname UpdateType: Mutable PrimitiveType: String .PARAMETER S3EncryptionEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3encryptionenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER S3KeyPrefix Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3keyprefix UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSClusterExecuteCommandLogConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $CloudWatchLogGroupName, [parameter(Mandatory = $false)] [object] $CloudWatchEncryptionEnabled, [parameter(Mandatory = $false)] [object] $S3BucketName, [parameter(Mandatory = $false)] [object] $S3EncryptionEnabled, [parameter(Mandatory = $false)] [object] $S3KeyPrefix ) Process { $obj = [ECSClusterExecuteCommandLogConfiguration]::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-VSECSClusterExecuteCommandLogConfiguration' function Add-VSECSServiceAwsVpcConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Service.AwsVpcConfiguration resource property to the template. The AwsVpcConfiguration property specifies an object representing the networking details for a task or service. .DESCRIPTION Adds an AWS::ECS::Service.AwsVpcConfiguration resource property to the template. The AwsVpcConfiguration property specifies an object representing the networking details for a task or service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html .PARAMETER AssignPublicIp Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-assignpublicip UpdateType: Mutable PrimitiveType: String .PARAMETER SecurityGroups The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. All specified security groups must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-securitygroups UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER Subnets The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. All specified subnets must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-subnets UpdateType: Mutable Type: List PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceAwsVpcConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AssignPublicIp, [parameter(Mandatory = $false)] $SecurityGroups, [parameter(Mandatory = $false)] $Subnets ) Process { $obj = [ECSServiceAwsVpcConfiguration]::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-VSECSServiceAwsVpcConfiguration' function Add-VSECSServiceCapacityProviderStrategyItem { <# .SYNOPSIS Adds an AWS::ECS::Service.CapacityProviderStrategyItem resource property to the template. .DESCRIPTION Adds an AWS::ECS::Service.CapacityProviderStrategyItem resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html .PARAMETER Base Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-base UpdateType: Mutable PrimitiveType: Integer .PARAMETER CapacityProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-capacityprovider UpdateType: Mutable PrimitiveType: String .PARAMETER Weight Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-weight UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceCapacityProviderStrategyItem])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Base, [parameter(Mandatory = $false)] [object] $CapacityProvider, [parameter(Mandatory = $false)] [object] $Weight ) Process { $obj = [ECSServiceCapacityProviderStrategyItem]::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-VSECSServiceCapacityProviderStrategyItem' function Add-VSECSServiceDeploymentCircuitBreaker { <# .SYNOPSIS Adds an AWS::ECS::Service.DeploymentCircuitBreaker resource property to the template. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentCircuitBreaker resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html .PARAMETER Enable Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-enable UpdateType: Mutable PrimitiveType: Boolean .PARAMETER Rollback Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-rollback UpdateType: Mutable PrimitiveType: Boolean .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceDeploymentCircuitBreaker])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Enable, [parameter(Mandatory = $true)] [object] $Rollback ) Process { $obj = [ECSServiceDeploymentCircuitBreaker]::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-VSECSServiceDeploymentCircuitBreaker' function Add-VSECSServiceDeploymentConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentConfiguration resource property to the template. The DeploymentConfiguration property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html .PARAMETER DeploymentCircuitBreaker *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-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-deploymentcircuitbreaker UpdateType: Mutable Type: DeploymentCircuitBreaker .PARAMETER MaximumPercent If a service is using the rolling update ECS deployment type, the **maximum percent** parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks rounded down to the nearest integer, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks provided that the cluster resources required to do this are available. The default value for maximum percent is 200%. If a service is using the blue/green CODE_DEPLOY or EXTERNAL deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-maximumpercent UpdateType: Mutable PrimitiveType: Integer .PARAMETER MinimumHealthyPercent If a service is using the rolling update ECS deployment type, the **minimum healthy percent** represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks rounded up to the nearest integer, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that *do not* use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that *do* use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the blue/green CODE_DEPLOY or EXTERNAL deployment types and tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-minimumhealthypercent UpdateType: Mutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceDeploymentConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $DeploymentCircuitBreaker, [parameter(Mandatory = $false)] [object] $MaximumPercent, [parameter(Mandatory = $false)] [object] $MinimumHealthyPercent ) Process { $obj = [ECSServiceDeploymentConfiguration]::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-VSECSServiceDeploymentConfiguration' function Add-VSECSServiceDeploymentController { <# .SYNOPSIS Adds an AWS::ECS::Service.DeploymentController resource property to the template. The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.DeploymentController resource property to the template. The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html .PARAMETER Type The deployment controller type to use. There are three deployment controller types available: ECS The rolling update ECS deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html. CODE_DEPLOY The blue/green CODE_DEPLOY deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. EXTERNAL The external EXTERNAL deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html#cfn-ecs-service-deploymentcontroller-type UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceDeploymentController])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Type ) Process { $obj = [ECSServiceDeploymentController]::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-VSECSServiceDeploymentController' function Add-VSECSServiceLoadBalancer { <# .SYNOPSIS Adds an AWS::ECS::Service.LoadBalancer resource property to the template. .DESCRIPTION Adds an AWS::ECS::Service.LoadBalancer resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html .PARAMETER ContainerName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER LoadBalancerName Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-loadbalancername UpdateType: Immutable PrimitiveType: String .PARAMETER TargetGroupArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-targetgrouparn UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceLoadBalancer])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $ContainerPort, [parameter(Mandatory = $false)] [object] $LoadBalancerName, [parameter(Mandatory = $false)] [object] $TargetGroupArn ) Process { $obj = [ECSServiceLoadBalancer]::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-VSECSServiceLoadBalancer' function Add-VSECSServiceNetworkConfiguration { <# .SYNOPSIS Adds an AWS::ECS::Service.NetworkConfiguration resource property to the template. The NetworkConfiguration property specifies an object representing the network configuration for a task or service. .DESCRIPTION Adds an AWS::ECS::Service.NetworkConfiguration resource property to the template. The NetworkConfiguration property specifies an object representing the network configuration for a task or service. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html .PARAMETER AwsvpcConfiguration The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html#cfn-ecs-service-networkconfiguration-awsvpcconfiguration UpdateType: Mutable Type: AwsVpcConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceNetworkConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $AwsvpcConfiguration ) Process { $obj = [ECSServiceNetworkConfiguration]::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-VSECSServiceNetworkConfiguration' function Add-VSECSServicePlacementConstraint { <# .SYNOPSIS Adds an AWS::ECS::Service.PlacementConstraint resource property to the template. The PlacementConstraint property specifies an object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.PlacementConstraint resource property to the template. The PlacementConstraint property specifies an object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html .PARAMETER Expression A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-expression UpdateType: Immutable PrimitiveType: String .PARAMETER Type The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServicePlacementConstraint])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Expression, [parameter(Mandatory = $true)] [object] $Type ) Process { $obj = [ECSServicePlacementConstraint]::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-VSECSServicePlacementConstraint' function Add-VSECSServicePlacementStrategy { <# .SYNOPSIS Adds an AWS::ECS::Service.PlacementStrategy resource property to the template. The PlacementStrategy property specifies the task placement strategy for a task or service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::Service.PlacementStrategy resource property to the template. The PlacementStrategy property specifies the task placement strategy for a task or service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html .PARAMETER Field The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId or host, which has the same effect, or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-field UpdateType: Immutable PrimitiveType: String .PARAMETER Type The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-type UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServicePlacementStrategy])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Field, [parameter(Mandatory = $true)] [object] $Type ) Process { $obj = [ECSServicePlacementStrategy]::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-VSECSServicePlacementStrategy' function Add-VSECSServiceServiceRegistry { <# .SYNOPSIS Adds an AWS::ECS::Service.ServiceRegistry resource property to the template. The ServiceRegistry property specifies details of the service registry. .DESCRIPTION Adds an AWS::ECS::Service.ServiceRegistry resource property to the template. The ServiceRegistry property specifies details of the service registry. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html .PARAMETER ContainerName The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER Port The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port UpdateType: Immutable PrimitiveType: Integer .PARAMETER RegistryArn The Amazon Resource Name ARN of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSServiceServiceRegistry])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $ContainerPort, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $RegistryArn ) Process { $obj = [ECSServiceServiceRegistry]::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-VSECSServiceServiceRegistry' function Add-VSECSTaskDefinitionAuthorizationConfig { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.AuthorizationConfig resource property to the template. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.AuthorizationConfig resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html .PARAMETER IAM Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-iam UpdateType: Immutable PrimitiveType: String .PARAMETER AccessPointId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-accesspointid UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionAuthorizationConfig])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IAM, [parameter(Mandatory = $false)] [object] $AccessPointId ) Process { $obj = [ECSTaskDefinitionAuthorizationConfig]::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-VSECSTaskDefinitionAuthorizationConfig' function Add-VSECSTaskDefinitionContainerDefinition { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.ContainerDefinition resource property to the template. The ContainerDefinition property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ContainerDefinition resource property to the template. The ContainerDefinition property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html .PARAMETER Command The command that is passed to the container. This parameter maps to Cmd in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the COMMAND parameter to docker run: https://docs.docker.com/engine/reference/run/. For more information, see https://docs.docker.com/engine/reference/builder/#cmd: https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-command UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Cpu The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cpu-shares option to docker run: https://docs.docker.com/engine/reference/run/. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances: http://aws.amazon.com/ec2/instance-types/ detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-cpu UpdateType: Immutable PrimitiveType: Integer .PARAMETER DependsOn The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dependson UpdateType: Immutable Type: List ItemType: ContainerDependency .PARAMETER DisableNetworking When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/. This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-disablenetworking UpdateType: Immutable PrimitiveType: Boolean .PARAMETER DnsSearchDomains A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --dns-search option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnssearchdomains UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER DnsServers A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --dns option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnsservers UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER DockerLabels A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --label option to docker run: https://docs.docker.com/engine/reference/run/. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockerlabels UpdateType: Immutable Type: Map PrimitiveItemType: String .PARAMETER DockerSecurityOptions A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type. With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to SecurityOpt in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --security-opt option to docker run: https://docs.docker.com/engine/reference/run/. The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER EntryPoint Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead. The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --entrypoint option to docker run: https://docs.docker.com/engine/reference/run/. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint: https://docs.docker.com/engine/reference/builder/#entrypoint. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-entrypoint UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Environment The environment variables to pass to a container. This parameter maps to Env in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --env option to docker run: https://docs.docker.com/engine/reference/run/. We do not recommend using plaintext environment variables for sensitive information, such as credential data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environment UpdateType: Immutable Type: List ItemType: KeyValuePair DuplicatesAllowed: False .PARAMETER EnvironmentFiles *Update requires*: 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-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environmentfiles UpdateType: Immutable Type: List ItemType: EnvironmentFile .PARAMETER Essential If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-essential UpdateType: Immutable PrimitiveType: Boolean .PARAMETER ExtraHosts A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --add-host option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers or tasks that use the awsvpc network mode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-extrahosts UpdateType: Immutable Type: List ItemType: HostEntry .PARAMETER FirelensConfiguration The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-firelensconfiguration UpdateType: Immutable Type: FirelensConfiguration .PARAMETER HealthCheck The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the HEALTHCHECK parameter of docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-healthcheck UpdateType: Immutable Type: HealthCheck .PARAMETER Hostname The hostname to use for your container. This parameter maps to Hostname in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --hostname option to docker run: https://docs.docker.com/engine/reference/run/. The hostname parameter is not supported if you are using the awsvpc network mode. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-hostname UpdateType: Immutable PrimitiveType: String .PARAMETER Image The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters uppercase and lowercase, numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the IMAGE parameter of docker run: https://docs.docker.com/engine/reference/run/. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name for example, ubuntu or mongo. + Images in other repositories on Docker Hub are qualified with an organization name for example, amazon/amazon-ecs-agent. + Images in other online repositories are qualified further by a domain name for example, quay.io/assemblyline/ubuntu. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-image UpdateType: Immutable PrimitiveType: String .PARAMETER Links The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links: https://docs.docker.com/network/links/ in the Docker documentation. This parameter maps to Links in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --link option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-links UpdateType: Immutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER LinuxParameters Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-linuxparameters UpdateType: Immutable Type: LinuxParameters .PARAMETER LogConfiguration The log configuration specification for the container. If you are using the Fargate launch type, the only supported value is awslogs. This parameter maps to LogConfig in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --log-driver option to docker run: https://docs.docker.com/engine/reference/run/. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance or on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers: https://docs.docker.com/engine/admin/logging/overview/ in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon shown in the LogConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html data type. Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration UpdateType: Immutable Type: LogConfiguration .PARAMETER Memory The amount in MiB of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --memory option to docker run: https://docs.docker.com/engine/reference/run/. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memory UpdateType: Immutable PrimitiveType: Integer .PARAMETER MemoryReservation The soft limit in MiB of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter if applicable, or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --memory-reservation option to docker run: https://docs.docker.com/engine/reference/run/. If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memoryreservation UpdateType: Immutable PrimitiveType: Integer .PARAMETER MountPoints The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --volume option to docker run: https://docs.docker.com/engine/reference/run/. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints UpdateType: Immutable Type: List ItemType: MountPoint DuplicatesAllowed: False .PARAMETER Name The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. This parameter maps to name in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --name option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-name UpdateType: Immutable PrimitiveType: String .PARAMETER PortMappings The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort. Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to PortBindings in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --publish option to docker run: https://docs.docker.com/engine/reference/run/. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html responses. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-portmappings UpdateType: Immutable Type: List ItemType: PortMapping DuplicatesAllowed: False .PARAMETER Privileged When this parameter is true, the container is given elevated privileges on the host container instance similar to the root user. This parameter maps to Privileged in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --privileged option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers or tasks using the Fargate launch type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-privileged UpdateType: Immutable PrimitiveType: Boolean .PARAMETER ReadonlyRootFilesystem When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --read-only option to docker run: https://docs.docker.com/engine/reference/run/. This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-readonlyrootfilesystem UpdateType: Immutable PrimitiveType: Boolean .PARAMETER RepositoryCredentials The private repository authentication credentials to use. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-repositorycredentials UpdateType: Immutable Type: RepositoryCredentials .PARAMETER ResourceRequirements The type and amount of a resource to assign to a container. The only supported resource is a GPU. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-resourcerequirements UpdateType: Immutable Type: List ItemType: ResourceRequirement .PARAMETER Secrets The secrets to pass to the container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-secrets UpdateType: Immutable Type: List ItemType: Secret .PARAMETER StartTimeout Time duration in seconds to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state. For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. If this parameter is not specified, the default value of 3 minutes is used. For tasks using the EC2 launch type, if the startTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_START_TIMEOUT is used by default. If neither the startTimeout parameter or the ECS_CONTAINER_START_TIMEOUT agent configuration variable are set, then the default values of 3 minutes for Linux containers and 8 minutes on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-starttimeout UpdateType: Immutable PrimitiveType: Integer .PARAMETER StopTimeout Time duration in seconds to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-stoptimeout UpdateType: Immutable PrimitiveType: Integer .PARAMETER Ulimits A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --ulimit option to docker run: https://docs.docker.com/engine/reference/run/. Valid naming values are displayed in the Ulimit: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-ulimits UpdateType: Immutable Type: List ItemType: Ulimit .PARAMETER User The user name to use inside the container. This parameter maps to User in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --user option to docker run: https://docs.docker.com/engine/reference/run/. You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer. + user + user:group + uid + uid:gid + user:gid + uid:group This parameter is not supported for Windows containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-user UpdateType: Immutable PrimitiveType: String .PARAMETER VolumesFrom Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --volumes-from option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom UpdateType: Immutable Type: List ItemType: VolumeFrom DuplicatesAllowed: False .PARAMETER WorkingDirectory The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --workdir option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-workingdirectory UpdateType: Immutable PrimitiveType: String .PARAMETER Interactive When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --interactive option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-interactive UpdateType: Immutable PrimitiveType: Boolean .PARAMETER PseudoTerminal When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --tty option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-pseudoterminal UpdateType: Immutable PrimitiveType: Boolean .PARAMETER SystemControls A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-systemcontrols UpdateType: Immutable Type: List ItemType: SystemControl .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionContainerDefinition])] [cmdletbinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","RepositoryCredentials")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPasswordParams","RepositoryCredentials")] Param( [parameter(Mandatory = $false)] $Command, [parameter(Mandatory = $false)] [object] $Cpu, [parameter(Mandatory = $false)] [object] $DependsOn, [parameter(Mandatory = $false)] [object] $DisableNetworking, [parameter(Mandatory = $false)] $DnsSearchDomains, [parameter(Mandatory = $false)] $DnsServers, [parameter(Mandatory = $false)] [IDictionary] $DockerLabels, [parameter(Mandatory = $false)] $DockerSecurityOptions, [parameter(Mandatory = $false)] $EntryPoint, [parameter(Mandatory = $false)] [object] $Environment, [parameter(Mandatory = $false)] [object] $EnvironmentFiles, [parameter(Mandatory = $false)] [object] $Essential, [parameter(Mandatory = $false)] [object] $ExtraHosts, [parameter(Mandatory = $false)] $FirelensConfiguration, [parameter(Mandatory = $false)] $HealthCheck, [parameter(Mandatory = $false)] [object] $Hostname, [parameter(Mandatory = $false)] [object] $Image, [parameter(Mandatory = $false)] $Links, [parameter(Mandatory = $false)] $LinuxParameters, [parameter(Mandatory = $false)] $LogConfiguration, [parameter(Mandatory = $false)] [object] $Memory, [parameter(Mandatory = $false)] [object] $MemoryReservation, [parameter(Mandatory = $false)] [object] $MountPoints, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $PortMappings, [parameter(Mandatory = $false)] [object] $Privileged, [parameter(Mandatory = $false)] [object] $ReadonlyRootFilesystem, [parameter(Mandatory = $false)] $RepositoryCredentials, [parameter(Mandatory = $false)] [object] $ResourceRequirements, [parameter(Mandatory = $false)] [object] $Secrets, [parameter(Mandatory = $false)] [object] $StartTimeout, [parameter(Mandatory = $false)] [object] $StopTimeout, [parameter(Mandatory = $false)] [object] $Ulimits, [parameter(Mandatory = $false)] [object] $User, [parameter(Mandatory = $false)] [object] $VolumesFrom, [parameter(Mandatory = $false)] [object] $WorkingDirectory, [parameter(Mandatory = $false)] [object] $Interactive, [parameter(Mandatory = $false)] [object] $PseudoTerminal, [parameter(Mandatory = $false)] [object] $SystemControls ) Process { $obj = [ECSTaskDefinitionContainerDefinition]::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-VSECSTaskDefinitionContainerDefinition' function Add-VSECSTaskDefinitionContainerDependency { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.ContainerDependency resource property to the template. The ContainerDependency property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ContainerDependency resource property to the template. The ContainerDependency property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. **Note** For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html .PARAMETER ContainerName The name of a container. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-containername UpdateType: Immutable PrimitiveType: String .PARAMETER Condition The dependency condition of the container. The following are the available conditions and their behavior: + START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + COMPLETE - This condition validates that a dependent container runs to completion exits before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. + SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. + HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-condition UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionContainerDependency])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $Condition ) Process { $obj = [ECSTaskDefinitionContainerDependency]::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-VSECSTaskDefinitionContainerDependency' function Add-VSECSTaskDefinitionDevice { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.Device resource property to the template. The Device property specifies an object representing a container instance host device. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Device resource property to the template. The Device property specifies an object representing a container instance host device. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html .PARAMETER ContainerPath The path inside the container at which to expose the host device. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-containerpath UpdateType: Immutable PrimitiveType: String .PARAMETER HostPath The path for the device on the host container instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-hostpath UpdateType: Immutable PrimitiveType: String .PARAMETER Permissions The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-permissions UpdateType: Immutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionDevice])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerPath, [parameter(Mandatory = $false)] [object] $HostPath, [parameter(Mandatory = $false)] $Permissions ) Process { $obj = [ECSTaskDefinitionDevice]::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-VSECSTaskDefinitionDevice' function Add-VSECSTaskDefinitionDockerVolumeConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.DockerVolumeConfiguration resource property to the template. The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.DockerVolumeConfiguration resource property to the template. The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html .PARAMETER Autoprovision If this value is true, the Docker volume is created if it does not already exist. This field is only used if the scope is shared. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-autoprovision UpdateType: Immutable PrimitiveType: Boolean .PARAMETER Driver The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery. This parameter maps to Driver in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxdriver option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver UpdateType: Immutable PrimitiveType: String .PARAMETER DriverOpts A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxopt option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts UpdateType: Immutable Type: Map PrimitiveItemType: String .PARAMETER Labels Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the xxlabel option to docker volume create: https://docs.docker.com/engine/reference/commandline/volume_create/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels UpdateType: Immutable Type: Map PrimitiveItemType: String .PARAMETER Scope The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-scope UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionDockerVolumeConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Autoprovision, [parameter(Mandatory = $false)] [object] $Driver, [parameter(Mandatory = $false)] [IDictionary] $DriverOpts, [parameter(Mandatory = $false)] [IDictionary] $Labels, [parameter(Mandatory = $false)] [object] $Scope ) Process { $obj = [ECSTaskDefinitionDockerVolumeConfiguration]::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-VSECSTaskDefinitionDockerVolumeConfiguration' function Add-VSECSTaskDefinitionEFSVolumeConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.EFSVolumeConfiguration resource property to the template. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.EFSVolumeConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html .PARAMETER FilesystemId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-filesystemid UpdateType: Immutable PrimitiveType: String .PARAMETER RootDirectory Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-rootdirectory UpdateType: Immutable PrimitiveType: String .PARAMETER TransitEncryption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryption UpdateType: Immutable PrimitiveType: String .PARAMETER TransitEncryptionPort Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryptionport UpdateType: Immutable PrimitiveType: Integer .PARAMETER AuthorizationConfig Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-authorizationconfig UpdateType: Immutable PrimitiveType: Json Type: AuthorizationConfig .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionEFSVolumeConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $FilesystemId, [parameter(Mandatory = $false)] [object] $RootDirectory, [parameter(Mandatory = $false)] [object] $TransitEncryption, [parameter(Mandatory = $false)] [object] $TransitEncryptionPort, [parameter(Mandatory = $false)] [VSJson] $AuthorizationConfig ) Process { $obj = [ECSTaskDefinitionEFSVolumeConfiguration]::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-VSECSTaskDefinitionEFSVolumeConfiguration' function Add-VSECSTaskDefinitionEnvironmentFile { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.EnvironmentFile resource property to the template. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.EnvironmentFile resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html .PARAMETER Value Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-value UpdateType: Immutable PrimitiveType: String .PARAMETER Type Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-type UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionEnvironmentFile])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Value, [parameter(Mandatory = $false)] [object] $Type ) Process { $obj = [ECSTaskDefinitionEnvironmentFile]::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-VSECSTaskDefinitionEnvironmentFile' function Add-VSECSTaskDefinitionFirelensConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.FirelensConfiguration resource property to the template. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.FirelensConfiguration resource property to the template. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html .PARAMETER Type The log router to use. The valid values are fluentd or fluentbit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-type UpdateType: Immutable PrimitiveType: String .PARAMETER Options The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + enable-ecs-log-metadata, which can be true or false + config-file-type, which can be s3 or file + config-file-value, which is either an S3 ARN or a file path Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-options UpdateType: Immutable Type: Map PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionFirelensConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Type, [parameter(Mandatory = $false)] [IDictionary] $Options ) Process { $obj = [ECSTaskDefinitionFirelensConfiguration]::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-VSECSTaskDefinitionFirelensConfiguration' function Add-VSECSTaskDefinitionHealthCheck { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.HealthCheck resource property to the template. The HealthCheck property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HealthCheck resource property to the template. The HealthCheck property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html .PARAMETER Command A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example: "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Interval The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval UpdateType: Immutable PrimitiveType: Integer .PARAMETER Timeout The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout UpdateType: Immutable PrimitiveType: Integer .PARAMETER Retries The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries UpdateType: Immutable PrimitiveType: Integer .PARAMETER StartPeriod The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default. If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod UpdateType: Immutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionHealthCheck])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Command, [parameter(Mandatory = $false)] [object] $Interval, [parameter(Mandatory = $false)] [object] $Timeout, [parameter(Mandatory = $false)] [object] $Retries, [parameter(Mandatory = $false)] [object] $StartPeriod ) Process { $obj = [ECSTaskDefinitionHealthCheck]::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-VSECSTaskDefinitionHealthCheck' function Add-VSECSTaskDefinitionHostEntry { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.HostEntry resource property to the template. The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HostEntry resource property to the template. The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html .PARAMETER Hostname The hostname to use in the /etc/hosts entry. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-hostname UpdateType: Immutable PrimitiveType: String .PARAMETER IpAddress The IP address to use in the /etc/hosts entry. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-ipaddress UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionHostEntry])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Hostname, [parameter(Mandatory = $false)] [object] $IpAddress ) Process { $obj = [ECSTaskDefinitionHostEntry]::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-VSECSTaskDefinitionHostEntry' function Add-VSECSTaskDefinitionHostVolumeProperties { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.HostVolumeProperties resource property to the template. The HostVolumeProperties property specifies details on a container instance bind mount host volume. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.HostVolumeProperties resource property to the template. The HostVolumeProperties property specifies details on a container instance bind mount host volume. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html .PARAMETER SourcePath When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you are using the Fargate launch type, the sourcePath parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html#cfn-ecs-taskdefinition-volumes-host-sourcepath UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionHostVolumeProperties])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SourcePath ) Process { $obj = [ECSTaskDefinitionHostVolumeProperties]::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-VSECSTaskDefinitionHostVolumeProperties' function Add-VSECSTaskDefinitionInferenceAccelerator { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.InferenceAccelerator resource property to the template. Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.InferenceAccelerator resource property to the template. Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html .PARAMETER DeviceName The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicename UpdateType: Immutable PrimitiveType: String .PARAMETER DeviceType The Elastic Inference accelerator type to use. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html#cfn-ecs-taskdefinition-inferenceaccelerator-devicetype UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionInferenceAccelerator])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DeviceName, [parameter(Mandatory = $false)] [object] $DeviceType ) Process { $obj = [ECSTaskDefinitionInferenceAccelerator]::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-VSECSTaskDefinitionInferenceAccelerator' function Add-VSECSTaskDefinitionKernelCapabilities { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.KernelCapabilities resource property to the template. The KernelCapabilities property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities in the *Docker run reference*. For more detailed information on these Linux capabilities, see the capabilities(7: http://man7.org/linux/man-pages/man7/capabilities.7.html Linux manual page. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.KernelCapabilities resource property to the template. The KernelCapabilities property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities in the *Docker run reference*. For more detailed information on these Linux capabilities, see the capabilities(7: http://man7.org/linux/man-pages/man7/capabilities.7.html Linux manual page. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html .PARAMETER Add The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cap-add option to docker run: https://docs.docker.com/engine/reference/run/. The SYS_PTRACE capability is supported for tasks that use the Fargate launch type if they are also using platform version 1.4.0. The other capabilities are not supported for any platform versions. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-add UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Drop The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --cap-drop option to docker run: https://docs.docker.com/engine/reference/run/. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-drop UpdateType: Immutable Type: List PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionKernelCapabilities])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Add, [parameter(Mandatory = $false)] $Drop ) Process { $obj = [ECSTaskDefinitionKernelCapabilities]::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-VSECSTaskDefinitionKernelCapabilities' function Add-VSECSTaskDefinitionKeyValuePair { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.KeyValuePair resource property to the template. The KeyValuePair property specifies a key-value pair object. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.KeyValuePair resource property to the template. The KeyValuePair property specifies a key-value pair object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html .PARAMETER Name The name of the key-value pair. For environment variables, this is the name of the environment variable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-name UpdateType: Immutable PrimitiveType: String .PARAMETER Value The value of the key-value pair. For environment variables, this is the value of the environment variable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-value UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionKeyValuePair])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ECSTaskDefinitionKeyValuePair]::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-VSECSTaskDefinitionKeyValuePair' function Add-VSECSTaskDefinitionLinuxParameters { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.LinuxParameters resource property to the template. The LinuxParameters property specifies Linux-specific options that are applied to the container, such as Linux KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.LinuxParameters resource property to the template. The LinuxParameters property specifies Linux-specific options that are applied to the container, such as Linux KernelCapabilities: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html .PARAMETER Capabilities The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities UpdateType: Immutable Type: KernelCapabilities .PARAMETER Devices Any host devices to expose to the container. This parameter maps to Devices in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --device option to docker run: https://docs.docker.com/engine/reference/run/. If you are using tasks that use the Fargate launch type, the devices parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-devices UpdateType: Immutable Type: List ItemType: Device .PARAMETER InitProcessEnabled Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run: https://docs.docker.com/engine/reference/run/. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-initprocessenabled UpdateType: Immutable PrimitiveType: Boolean .PARAMETER MaxSwap The total amount of swap memory in MiB a container can use. This parameter will be translated to the --memory-swap option to docker run: https://docs.docker.com/engine/reference/run/ where the value would be the sum of the container memory plus the maxSwap value. If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used. If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-maxswap UpdateType: Immutable PrimitiveType: Integer .PARAMETER SharedMemorySize The value for the size in MiB of the /dev/shm volume. This parameter maps to the --shm-size option to docker run: https://docs.docker.com/engine/reference/run/. If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-sharedmemorysize UpdateType: Immutable PrimitiveType: Integer .PARAMETER Swappiness This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run: https://docs.docker.com/engine/reference/run/. If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-swappiness UpdateType: Immutable PrimitiveType: Integer .PARAMETER Tmpfs The container path, mount options, and size in MiB of the tmpfs mount. This parameter maps to the --tmpfs option to docker run: https://docs.docker.com/engine/reference/run/. If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-tmpfs UpdateType: Immutable Type: List ItemType: Tmpfs .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionLinuxParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Capabilities, [parameter(Mandatory = $false)] [object] $Devices, [parameter(Mandatory = $false)] [object] $InitProcessEnabled, [parameter(Mandatory = $false)] [object] $MaxSwap, [parameter(Mandatory = $false)] [object] $SharedMemorySize, [parameter(Mandatory = $false)] [object] $Swappiness, [parameter(Mandatory = $false)] [object] $Tmpfs ) Process { $obj = [ECSTaskDefinitionLinuxParameters]::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-VSECSTaskDefinitionLinuxParameters' function Add-VSECSTaskDefinitionLogConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.LogConfiguration resource property to the template. The LogConfiguration property specifies log configuration options to send to a custom log driver for the container. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.LogConfiguration resource property to the template. The LogConfiguration property specifies log configuration options to send to a custom log driver for the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html .PARAMETER LogDriver The log driver to use for the container. The valid values listed earlier are log drivers that the Amazon ECS container agent can communicate with by default. For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens. For more information about using the awslogs log driver, see Using the awslogs Log Driver: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html in the *Amazon Elastic Container Service Developer Guide*. For more information about using the awsfirelens log driver, see Custom Log Routing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub: https://github.com/aws/amazon-ecs-agent and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-logdriver UpdateType: Immutable PrimitiveType: String .PARAMETER Options The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-options UpdateType: Immutable Type: Map PrimitiveItemType: String .PARAMETER SecretOptions The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-secretoptions UpdateType: Immutable Type: List ItemType: Secret .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionLogConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $LogDriver, [parameter(Mandatory = $false)] [IDictionary] $Options, [parameter(Mandatory = $false)] [object] $SecretOptions ) Process { $obj = [ECSTaskDefinitionLogConfiguration]::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-VSECSTaskDefinitionLogConfiguration' function Add-VSECSTaskDefinitionMountPoint { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.MountPoint resource property to the template. The MountPoint property specifies details on a volume mount point that is used in a container definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.MountPoint resource property to the template. The MountPoint property specifies details on a volume mount point that is used in a container definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html .PARAMETER ContainerPath The path on the container to mount the host volume at. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-containerpath UpdateType: Immutable PrimitiveType: String .PARAMETER ReadOnly If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-readonly UpdateType: Immutable PrimitiveType: Boolean .PARAMETER SourceVolume The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-sourcevolume UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionMountPoint])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerPath, [parameter(Mandatory = $false)] [object] $ReadOnly, [parameter(Mandatory = $false)] [object] $SourceVolume ) Process { $obj = [ECSTaskDefinitionMountPoint]::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-VSECSTaskDefinitionMountPoint' function Add-VSECSTaskDefinitionPortMapping { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.PortMapping resource property to the template. The PortMapping property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.PortMapping resource property to the template. The PortMapping property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html API responses. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html .PARAMETER ContainerPort The port number on the container that is bound to the user-specified or automatically assigned host port. If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER HostPort The port number on the container instance to reserve for your container. If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort. If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort or set it to 0 while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-readonly UpdateType: Immutable PrimitiveType: Integer .PARAMETER Protocol The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-sourcevolume UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionPortMapping])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerPort, [parameter(Mandatory = $false)] [object] $HostPort, [parameter(Mandatory = $false)] [object] $Protocol ) Process { $obj = [ECSTaskDefinitionPortMapping]::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-VSECSTaskDefinitionPortMapping' function Add-VSECSTaskDefinitionProxyConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.ProxyConfiguration resource property to the template. The ProxyConfiguration property specifies the details for the App Mesh proxy. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ProxyConfiguration resource property to the template. The ProxyConfiguration property specifies the details for the App Mesh proxy. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html .PARAMETER ContainerName The name of the container that will serve as the App Mesh proxy. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ProxyConfigurationProperties The set of network configuration parameters to provide the Container Network Interface CNI plugin, specified as key-value pairs. + IgnoredUID - Required The user ID UID of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty. + IgnoredGID - Required The group ID GID of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty. + AppPorts - Required The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort. + ProxyIngressPort - Required Specifies the port that incoming traffic to the AppPorts is directed to. + ProxyEgressPort - Required Specifies the port that outgoing traffic from the AppPorts is directed to. + EgressIgnoredPorts - Required The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list. + EgressIgnoredIPs - Required The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-proxyconfigurationproperties UpdateType: Immutable Type: List ItemType: KeyValuePair DuplicatesAllowed: False .PARAMETER Type The proxy type. The only supported value is APPMESH. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-type UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionProxyConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $ProxyConfigurationProperties, [parameter(Mandatory = $false)] [object] $Type ) Process { $obj = [ECSTaskDefinitionProxyConfiguration]::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-VSECSTaskDefinitionProxyConfiguration' function Add-VSECSTaskDefinitionRepositoryCredentials { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.RepositoryCredentials resource property to the template. The RepositoryCredentials property specifies the repository credentials for private registry authentication. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.RepositoryCredentials resource property to the template. The RepositoryCredentials property specifies the repository credentials for private registry authentication. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html .PARAMETER CredentialsParameter The Amazon Resource Name ARN of the secret containing the private repository credentials. When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html#cfn-ecs-taskdefinition-repositorycredentials-credentialsparameter UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionRepositoryCredentials])] [cmdletbinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","CredentialsParameter")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPasswordParams","CredentialsParameter")] Param( [parameter(Mandatory = $false)] [object] $CredentialsParameter ) Process { $obj = [ECSTaskDefinitionRepositoryCredentials]::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-VSECSTaskDefinitionRepositoryCredentials' function Add-VSECSTaskDefinitionResourceRequirement { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.ResourceRequirement resource property to the template. The ResourceRequirement property specifies the type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html in the *Amazon Elastic Container Service Developer Guide* .DESCRIPTION Adds an AWS::ECS::TaskDefinition.ResourceRequirement resource property to the template. The ResourceRequirement property specifies the type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html in the *Amazon Elastic Container Service Developer Guide* .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html .PARAMETER Type The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-type UpdateType: Immutable PrimitiveType: String .PARAMETER Value The value for the specified resource type. If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on. If the InferenceAccelerator type is used, the value should match the DeviceName for an InferenceAccelerator: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html specified in a task definition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-value UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionResourceRequirement])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $true)] [object] $Value ) Process { $obj = [ECSTaskDefinitionResourceRequirement]::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-VSECSTaskDefinitionResourceRequirement' function Add-VSECSTaskDefinitionSecret { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.Secret resource property to the template. The Secret property specifies an object representing the secret to expose to your container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Secret resource property to the template. The Secret property specifies an object representing the secret to expose to your container. For more information, see Specifying Sensitive Data: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html .PARAMETER Name The name of the secret. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-name UpdateType: Immutable PrimitiveType: String .PARAMETER ValueFrom The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-valuefrom UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionSecret])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $ValueFrom ) Process { $obj = [ECSTaskDefinitionSecret]::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-VSECSTaskDefinitionSecret' function Add-VSECSTaskDefinitionSystemControl { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.SystemControl resource property to the template. A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.SystemControl resource property to the template. A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate section of the Docker Remote API: https://docs.docker.com/engine/api/v1.35/ and the --sysctl option to docker run: https://docs.docker.com/engine/reference/run/. It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons: + For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect. + For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html .PARAMETER Namespace The namespaced kernel parameter for which to set a value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-namespace UpdateType: Immutable PrimitiveType: String .PARAMETER Value The value for the namespaced kernel parameter specified in namespace. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-value UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionSystemControl])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Namespace, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ECSTaskDefinitionSystemControl]::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-VSECSTaskDefinitionSystemControl' function Add-VSECSTaskDefinitionTaskDefinitionPlacementConstraint { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint resource property to the template. The TaskDefinitionPlacementConstraint property specifies an object representing a constraint on task placement in the task definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint resource property to the template. The TaskDefinitionPlacementConstraint property specifies an object representing a constraint on task placement in the task definition. If you are using the Fargate launch type, task placement constraints are not supported. For more information, see Task Placement Constraints: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html .PARAMETER Type The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type UpdateType: Immutable PrimitiveType: String .PARAMETER Expression A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-expression UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionTaskDefinitionPlacementConstraint])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] [object] $Expression ) Process { $obj = [ECSTaskDefinitionTaskDefinitionPlacementConstraint]::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-VSECSTaskDefinitionTaskDefinitionPlacementConstraint' function Add-VSECSTaskDefinitionTmpfs { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.Tmpfs resource property to the template. The Tmpfs property specifies the container path, mount options, and size of the tmpfs mount. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Tmpfs resource property to the template. The Tmpfs property specifies the container path, mount options, and size of the tmpfs mount. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html .PARAMETER ContainerPath The absolute file path where the tmpfs volume is to be mounted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-containerpath UpdateType: Immutable PrimitiveType: String .PARAMETER MountOptions The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol" Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-mountoptions UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Size The size in MiB of the tmpfs volume. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-size UpdateType: Immutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionTmpfs])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerPath, [parameter(Mandatory = $false)] $MountOptions, [parameter(Mandatory = $true)] [object] $Size ) Process { $obj = [ECSTaskDefinitionTmpfs]::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-VSECSTaskDefinitionTmpfs' function Add-VSECSTaskDefinitionUlimit { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.Ulimit resource property to the template. The Ulimit property specifies the ulimit settings to pass to the container. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Ulimit resource property to the template. The Ulimit property specifies the ulimit settings to pass to the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html .PARAMETER HardLimit The hard limit for the ulimit type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-hardlimit UpdateType: Immutable PrimitiveType: Integer .PARAMETER Name The type of the ulimit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-name UpdateType: Immutable PrimitiveType: String .PARAMETER SoftLimit The soft limit for the ulimit type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-softlimit UpdateType: Immutable PrimitiveType: Integer .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionUlimit])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HardLimit, [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $SoftLimit ) Process { $obj = [ECSTaskDefinitionUlimit]::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-VSECSTaskDefinitionUlimit' function Add-VSECSTaskDefinitionVolume { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.Volume resource property to the template. The Volume property specifies a data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.Volume resource property to the template. The Volume property specifies a data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html .PARAMETER DockerVolumeConfiguration This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration UpdateType: Immutable Type: DockerVolumeConfiguration .PARAMETER EFSVolumeConfiguration *Update requires*: 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-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volume-efsvolumeconfiguration UpdateType: Immutable Type: EFSVolumeConfiguration .PARAMETER Host This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:mypath:C:mypath and D::D:, but not D:mypath:C:mypath or D::C:mypath. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-host UpdateType: Immutable Type: HostVolumeProperties .PARAMETER Name The name of the volume. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-name UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionVolume])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $DockerVolumeConfiguration, [parameter(Mandatory = $false)] $EFSVolumeConfiguration, [parameter(Mandatory = $false)] $Host, [parameter(Mandatory = $false)] [object] $Name ) Process { $obj = [ECSTaskDefinitionVolume]::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-VSECSTaskDefinitionVolume' function Add-VSECSTaskDefinitionVolumeFrom { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition.VolumeFrom resource property to the template. The VolumeFrom property specifies details on a data volume from another container in the same task definition. .DESCRIPTION Adds an AWS::ECS::TaskDefinition.VolumeFrom resource property to the template. The VolumeFrom property specifies details on a data volume from another container in the same task definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html .PARAMETER ReadOnly If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-readonly UpdateType: Immutable PrimitiveType: Boolean .PARAMETER SourceContainer The name of another container within the same task definition from which to mount volumes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-sourcecontainer UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskDefinitionVolumeFrom])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ReadOnly, [parameter(Mandatory = $false)] [object] $SourceContainer ) Process { $obj = [ECSTaskDefinitionVolumeFrom]::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-VSECSTaskDefinitionVolumeFrom' function Add-VSECSTaskSetAwsVpcConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskSet.AwsVpcConfiguration resource property to the template. The networking details for a task. .DESCRIPTION Adds an AWS::ECS::TaskSet.AwsVpcConfiguration resource property to the template. The networking details for a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html .PARAMETER AssignPublicIp Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-assignpublicip UpdateType: Immutable PrimitiveType: String .PARAMETER SecurityGroups The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. All specified security groups must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-securitygroups UpdateType: Immutable Type: List PrimitiveItemType: String .PARAMETER Subnets The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. All specified subnets must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-subnets UpdateType: Immutable Type: List PrimitiveItemType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskSetAwsVpcConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AssignPublicIp, [parameter(Mandatory = $false)] $SecurityGroups, [parameter(Mandatory = $true)] $Subnets ) Process { $obj = [ECSTaskSetAwsVpcConfiguration]::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-VSECSTaskSetAwsVpcConfiguration' function Add-VSECSTaskSetLoadBalancer { <# .SYNOPSIS Adds an AWS::ECS::TaskSet.LoadBalancer resource property to the template. Details on the load balancer or load balancers to use with a task set. .DESCRIPTION Adds an AWS::ECS::TaskSet.LoadBalancer resource property to the template. Details on the load balancer or load balancers to use with a task set. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html .PARAMETER ContainerName The name of the container as it appears in a container definition to associate with the load balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER LoadBalancerName The name of the load balancer to associate with the Amazon ECS service or task set. A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-loadbalancername UpdateType: Immutable PrimitiveType: String .PARAMETER TargetGroupArn The full Amazon Resource Name ARN of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the *Amazon Elastic Container Service Developer Guide*. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the awsvpc network mode which is required for the Fargate launch type, you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-targetgrouparn UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskSetLoadBalancer])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $ContainerPort, [parameter(Mandatory = $false)] [object] $LoadBalancerName, [parameter(Mandatory = $false)] [object] $TargetGroupArn ) Process { $obj = [ECSTaskSetLoadBalancer]::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-VSECSTaskSetLoadBalancer' function Add-VSECSTaskSetNetworkConfiguration { <# .SYNOPSIS Adds an AWS::ECS::TaskSet.NetworkConfiguration resource property to the template. The network configuration for a task. .DESCRIPTION Adds an AWS::ECS::TaskSet.NetworkConfiguration resource property to the template. The network configuration for a task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html .PARAMETER AwsVpcConfiguration The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html#cfn-ecs-taskset-networkconfiguration-awsvpcconfiguration UpdateType: Immutable Type: AwsVpcConfiguration .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskSetNetworkConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $AwsVpcConfiguration ) Process { $obj = [ECSTaskSetNetworkConfiguration]::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-VSECSTaskSetNetworkConfiguration' function Add-VSECSTaskSetScale { <# .SYNOPSIS Adds an AWS::ECS::TaskSet.Scale resource property to the template. A floating-point percentage of the desired number of tasks to place and keep running in the task set. .DESCRIPTION Adds an AWS::ECS::TaskSet.Scale resource property to the template. A floating-point percentage of the desired number of tasks to place and keep running in the task set. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html .PARAMETER Unit The unit of measure for the scale value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-unit UpdateType: Mutable PrimitiveType: String .PARAMETER Value The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-value UpdateType: Mutable PrimitiveType: Double .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskSetScale])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Unit, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [ECSTaskSetScale]::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-VSECSTaskSetScale' function Add-VSECSTaskSetServiceRegistry { <# .SYNOPSIS Adds an AWS::ECS::TaskSet.ServiceRegistry resource property to the template. Details of the service registry. .DESCRIPTION Adds an AWS::ECS::TaskSet.ServiceRegistry resource property to the template. Details of the service registry. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html .PARAMETER ContainerName The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containername UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerPort The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containerport UpdateType: Immutable PrimitiveType: Integer .PARAMETER Port The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-port UpdateType: Immutable PrimitiveType: Integer .PARAMETER RegistryArn The Amazon Resource Name ARN of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-registryarn UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([ECSTaskSetServiceRegistry])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ContainerName, [parameter(Mandatory = $false)] [object] $ContainerPort, [parameter(Mandatory = $false)] [object] $Port, [parameter(Mandatory = $false)] [object] $RegistryArn ) Process { $obj = [ECSTaskSetServiceRegistry]::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-VSECSTaskSetServiceRegistry' function New-VSECSCapacityProvider { <# .SYNOPSIS Adds an AWS::ECS::CapacityProvider resource to the template. .DESCRIPTION Adds an AWS::ECS::CapacityProvider resource to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.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 AutoScalingGroupProvider Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider UpdateType: Immutable Type: AutoScalingGroupProvider .PARAMETER Name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name UpdateType: Immutable PrimitiveType: String .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags UpdateType: Mutable Type: List ItemType: Tag .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([ECSCapacityProvider])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] $AutoScalingGroupProvider, [parameter(Mandatory = $false)] [object] $Name, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [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 = [ECSCapacityProvider]::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-VSECSCapacityProvider' function New-VSECSCluster { <# .SYNOPSIS Adds an AWS::ECS::Cluster resource to the template. The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS cluster. .DESCRIPTION Adds an AWS::ECS::Cluster resource to the template. The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS cluster. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.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 Tags The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER ClusterName A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername UpdateType: Immutable PrimitiveType: String .PARAMETER ClusterSettings The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html or PutAccountSettingDefault: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings UpdateType: Mutable Type: List ItemType: ClusterSettings .PARAMETER CapacityProviders Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-capacityproviders UpdateType: Mutable Type: List PrimitiveItemType: String .PARAMETER DefaultCapacityProviderStrategy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-defaultcapacityproviderstrategy UpdateType: Mutable Type: List ItemType: CapacityProviderStrategyItem .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([ECSCluster])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] [object] $ClusterName, [parameter(Mandatory = $false)] [object] $ClusterSettings, [parameter(Mandatory = $false)] $CapacityProviders, [parameter(Mandatory = $false)] [object] $DefaultCapacityProviderStrategy, [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 = [ECSCluster]::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-VSECSCluster' function New-VSECSPrimaryTaskSet { <# .SYNOPSIS Adds an AWS::ECS::PrimaryTaskSet resource to the template. Specifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::PrimaryTaskSet resource to the template. Specifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.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 Cluster The short name or full Amazon Resource Name ARN of the cluster that hosts the service that the task set exists in. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-cluster UpdateType: Immutable PrimitiveType: String .PARAMETER TaskSetId The short name or full Amazon Resource Name ARN of the task set to set as the primary task set in the deployment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-tasksetid UpdateType: Mutable PrimitiveType: String .PARAMETER Service The short name or full Amazon Resource Name ARN of the service that the task set exists in. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-service UpdateType: Immutable PrimitiveType: String .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([ECSPrimaryTaskSet])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Cluster, [parameter(Mandatory = $true)] [object] $TaskSetId, [parameter(Mandatory = $true)] [object] $Service, [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 = [ECSPrimaryTaskSet]::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-VSECSPrimaryTaskSet' function New-VSECSService { <# .SYNOPSIS Adds an AWS::ECS::Service resource to the template. The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS service that runs and maintains the requested number of tasks and associated load balancers. .DESCRIPTION Adds an AWS::ECS::Service resource to the template. The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS service that runs and maintains the requested number of tasks and associated load balancers. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.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 ServiceArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicearn UpdateType: Mutable PrimitiveType: String .PARAMETER CapacityProviderStrategy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy UpdateType: Mutable Type: List ItemType: CapacityProviderStrategyItem .PARAMETER Cluster The short name or full Amazon Resource Name ARN of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster UpdateType: Immutable PrimitiveType: String .PARAMETER DeploymentConfiguration Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration UpdateType: Mutable Type: DeploymentConfiguration .PARAMETER DeploymentController The deployment controller to use for the service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller UpdateType: Immutable Type: DeploymentController .PARAMETER DesiredCount The number of instantiations of the specified task definition to place and keep running on your cluster. This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount UpdateType: Mutable PrimitiveType: Integer .PARAMETER EnableECSManagedTags Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags UpdateType: Immutable PrimitiveType: Boolean .PARAMETER HealthCheckGracePeriodSeconds The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds UpdateType: Mutable PrimitiveType: Integer .PARAMETER LaunchType The launch type on which to run your service. For more information, see Amazon ECS Launch Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype UpdateType: Immutable PrimitiveType: String .PARAMETER LoadBalancers A list of load balancer objects to associate with the cluster. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers UpdateType: Immutable Type: List ItemType: LoadBalancer .PARAMETER NetworkConfiguration The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration UpdateType: Mutable Type: NetworkConfiguration .PARAMETER PlacementConstraints An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task this limit includes constraints in the task definition and those specified at runtime. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints UpdateType: Immutable Type: List ItemType: PlacementConstraint .PARAMETER PlacementStrategies The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies UpdateType: Immutable Type: List ItemType: PlacementStrategy .PARAMETER PlatformVersion The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion UpdateType: Immutable PrimitiveType: String .PARAMETER PropagateTags Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html API action. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags UpdateType: Immutable PrimitiveType: String .PARAMETER Role The name or full Amazon Resource Name ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than /, then you must either specify the full role ARN this is recommended or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names in the *IAM User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role UpdateType: Immutable PrimitiveType: String .PARAMETER SchedulingStrategy The scheduling strategy to use for the service. For more information, see Services: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html. There are two service scheduler strategies available: + REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types. + DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. **Note** Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy UpdateType: Immutable PrimitiveType: String .PARAMETER ServiceName The name of your service. Up to 255 letters uppercase and lowercase, numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename UpdateType: Immutable PrimitiveType: String .PARAMETER ServiceRegistries The details of the service discovery registries to assign to this service. For more information, see Service Discovery: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries UpdateType: Immutable Type: List ItemType: ServiceRegistry .PARAMETER Tags The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags UpdateType: Mutable Type: List ItemType: Tag .PARAMETER TaskDefinition The family and revision family:revision or full ARN of the task definition to run in your service. The revision is required in order for the resource to stabilize. A task definition must be specified if the service is using the ECS deployment controller. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition UpdateType: Mutable PrimitiveType: String .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([ECSService])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $ServiceArn, [parameter(Mandatory = $false)] [object] $CapacityProviderStrategy, [parameter(Mandatory = $false)] [object] $Cluster, [parameter(Mandatory = $false)] $DeploymentConfiguration, [parameter(Mandatory = $false)] $DeploymentController, [parameter(Mandatory = $false)] [object] $DesiredCount, [parameter(Mandatory = $false)] [object] $EnableECSManagedTags, [parameter(Mandatory = $false)] [object] $HealthCheckGracePeriodSeconds, [parameter(Mandatory = $false)] [object] $LaunchType, [parameter(Mandatory = $false)] [object] $LoadBalancers, [parameter(Mandatory = $false)] $NetworkConfiguration, [parameter(Mandatory = $false)] [object] $PlacementConstraints, [parameter(Mandatory = $false)] [object] $PlacementStrategies, [parameter(Mandatory = $false)] [object] $PlatformVersion, [parameter(Mandatory = $false)] [object] $PropagateTags, [parameter(Mandatory = $false)] [object] $Role, [parameter(Mandatory = $false)] [object] $SchedulingStrategy, [parameter(Mandatory = $false)] [object] $ServiceName, [parameter(Mandatory = $false)] [object] $ServiceRegistries, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] [object] $TaskDefinition, [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 = [ECSService]::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-VSECSService' function New-VSECSTaskDefinition { <# .SYNOPSIS Adds an AWS::ECS::TaskDefinition resource to the template. The AWS::ECS::TaskDefinition resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task. .DESCRIPTION Adds an AWS::ECS::TaskDefinition resource to the template. The AWS::ECS::TaskDefinition resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.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 Family The name of a family that this task definition is registered to. Up to 255 letters uppercase and lowercase, numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family UpdateType: Immutable PrimitiveType: String .PARAMETER ContainerDefinitions A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions UpdateType: Immutable Type: List ItemType: ContainerDefinition DuplicatesAllowed: False .PARAMETER Cpu Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu UpdateType: Immutable PrimitiveType: String .PARAMETER ExecutionRoleArn The Amazon Resource Name ARN of the task execution role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn UpdateType: Immutable PrimitiveType: String .PARAMETER InferenceAccelerators The Elastic Inference accelerators to use for the containers in the task. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-inferenceaccelerators UpdateType: Immutable Type: List ItemType: InferenceAccelerator DuplicatesAllowed: False .PARAMETER Memory The amount in MiB of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory UpdateType: Immutable PrimitiveType: String .PARAMETER NetworkMode The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port for the host network mode or the attached elastic network interface port for the awsvpc network mode, so you cannot take advantage of dynamic host port mappings. If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html value when you create a service or run a task with the task definition. For more information, see Task Networking: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html in the *Amazon Elastic Container Service Developer Guide*. Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode. If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object. For more information, see Network settings: https://docs.docker.com/engine/reference/run/#network-settings in the *Docker run reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode UpdateType: Immutable PrimitiveType: String .PARAMETER PlacementConstraints An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints UpdateType: Immutable Type: List ItemType: TaskDefinitionPlacementConstraint DuplicatesAllowed: False .PARAMETER ProxyConfiguration The ProxyConfiguration property specifies the configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-proxyconfiguration UpdateType: Immutable Type: ProxyConfiguration .PARAMETER RequiresCompatibilities The launch type the task requires. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities UpdateType: Immutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER TaskRoleArn The short name or full Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn UpdateType: Immutable PrimitiveType: String .PARAMETER Volumes The list of volume definitions for the task. If your tasks are using the Fargate launch type, the host and sourcePath parameters are not supported. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html in the *Amazon Elastic Container Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes UpdateType: Immutable Type: List ItemType: Volume DuplicatesAllowed: False .PARAMETER PidMode The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings: https://docs.docker.com/engine/reference/run/#pid-settings---pid in the *Docker run reference*. If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security: https://docs.docker.com/engine/security/security/. This parameter is not supported for Windows containers or tasks using the Fargate launch type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-pidmode UpdateType: Immutable PrimitiveType: String .PARAMETER IpcMode The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc in the *Docker run reference*. If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security: https://docs.docker.com/engine/security/security/. If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the host IPC mode, IPC namespace related systemControls are not supported. + For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task. This parameter is not supported for Windows containers or tasks using the Fargate launch type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ipcmode UpdateType: Immutable PrimitiveType: String .PARAMETER Tags The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-tags UpdateType: Mutable Type: List ItemType: Tag .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([ECSTaskDefinition])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $Family, [parameter(Mandatory = $false)] [object] $ContainerDefinitions, [parameter(Mandatory = $false)] [object] $Cpu, [parameter(Mandatory = $false)] [object] $ExecutionRoleArn, [parameter(Mandatory = $false)] [object] $InferenceAccelerators, [parameter(Mandatory = $false)] [object] $Memory, [parameter(Mandatory = $false)] [object] $NetworkMode, [parameter(Mandatory = $false)] [object] $PlacementConstraints, [parameter(Mandatory = $false)] $ProxyConfiguration, [parameter(Mandatory = $false)] $RequiresCompatibilities, [parameter(Mandatory = $false)] [object] $TaskRoleArn, [parameter(Mandatory = $false)] [object] $Volumes, [parameter(Mandatory = $false)] [object] $PidMode, [parameter(Mandatory = $false)] [object] $IpcMode, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [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 = [ECSTaskDefinition]::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-VSECSTaskDefinition' function New-VSECSTaskSet { <# .SYNOPSIS Adds an AWS::ECS::TaskSet resource to the template. Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .DESCRIPTION Adds an AWS::ECS::TaskSet resource to the template. Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html in the *Amazon Elastic Container Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.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 Cluster The short name or full Amazon Resource Name ARN of the cluster that hosts the service to create the task set in. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster UpdateType: Immutable PrimitiveType: String .PARAMETER ExternalId An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid UpdateType: Immutable PrimitiveType: String .PARAMETER LaunchType The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the *Amazon Elastic Container Service Developer Guide*. If a launchType is specified, the capacityProviderStrategy parameter must be omitted. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype UpdateType: Immutable PrimitiveType: String .PARAMETER LoadBalancers A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers UpdateType: Immutable Type: List ItemType: LoadBalancer .PARAMETER NetworkConfiguration The network configuration for the task set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration UpdateType: Immutable Type: NetworkConfiguration .PARAMETER PlatformVersion The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion UpdateType: Immutable PrimitiveType: String .PARAMETER Scale A floating-point percentage of the desired number of tasks to place and keep running in the task set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale UpdateType: Mutable Type: Scale .PARAMETER Service The short name or full Amazon Resource Name ARN of the service to create the task set in. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service UpdateType: Immutable PrimitiveType: String .PARAMETER ServiceRegistries The details of the service discovery registries to assign to this task set. For more information, see Service Discovery: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries UpdateType: Immutable Type: List ItemType: ServiceRegistry .PARAMETER TaskDefinition The task definition for the tasks in the task set to use. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition UpdateType: Immutable PrimitiveType: String .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([ECSTaskSet])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Cluster, [parameter(Mandatory = $false)] [object] $ExternalId, [parameter(Mandatory = $false)] [object] $LaunchType, [parameter(Mandatory = $false)] [object] $LoadBalancers, [parameter(Mandatory = $false)] $NetworkConfiguration, [parameter(Mandatory = $false)] [object] $PlatformVersion, [parameter(Mandatory = $false)] $Scale, [parameter(Mandatory = $true)] [object] $Service, [parameter(Mandatory = $false)] [object] $ServiceRegistries, [parameter(Mandatory = $true)] [object] $TaskDefinition, [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 = [ECSTaskSet]::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-VSECSTaskSet' |