VaporShell.Batch.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-VSBatchComputeEnvironmentComputeResources { <# .SYNOPSIS Adds an AWS::Batch::ComputeEnvironment.ComputeResources resource property to the template. Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment.ComputeResources resource property to the template. Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html .PARAMETER SpotIamFleetRole The Amazon Resource Name ARN of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy is not specified. For more information, see Amazon EC2 Spot Fleet Role: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole PrimitiveType: String UpdateType: Immutable .PARAMETER MaxvCpus The maximum number of Amazon EC2 vCPUs that an environment can reach. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER Ec2Configuration + Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration ItemType: Ec2ConfigurationObject UpdateType: Immutable .PARAMETER BidPercentage The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest market price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage PrimitiveType: Integer UpdateType: Immutable .PARAMETER SecurityGroupIds The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids UpdateType: Mutable .PARAMETER Subnets The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html in the *Amazon VPC User Guide*. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets UpdateType: Mutable .PARAMETER Type The type of compute environment: EC2 or SPOT. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type PrimitiveType: String UpdateType: Immutable .PARAMETER AllocationStrategy The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. BEST_FIT_PROGRESSIVE will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. For more information, see Allocation Strategies: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy PrimitiveType: String UpdateType: Immutable .PARAMETER MinvCpus The minimum number of Amazon EC2 vCPUs that an environment should maintain even if the compute environment is DISABLED. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus PrimitiveType: Integer UpdateType: Mutable .PARAMETER LaunchTemplate The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment: https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html in the *AWS Batch User Guide*. Type: LaunchTemplateSpecification Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate UpdateType: Immutable .PARAMETER ImageId The Amazon Machine Image AMI ID used for instances launched in the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceRole The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name ARN of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role: https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole PrimitiveType: String UpdateType: Immutable .PARAMETER InstanceTypes The instances types that may be launched. You can specify instance families to launch any instance type within those families for example, c5 or p3, or you can specify specific sizes within a family such as c5.8xlarge. You can also choose optimal to pick instance types from the C, M, and R instance families on the fly that match the demand of your job queues. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes UpdateType: Immutable .PARAMETER Ec2KeyPair The Amazon EC2 key pair that is used for instances launched in the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair PrimitiveType: String UpdateType: Immutable .PARAMETER PlacementGroup The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html in the *Amazon EC2 User Guide for Linux Instances*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup PrimitiveType: String UpdateType: Immutable .PARAMETER Tags Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags PrimitiveType: Json UpdateType: Immutable .PARAMETER DesiredvCpus The desired number of Amazon EC2 vCPUS in the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchComputeEnvironmentComputeResources])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SpotIamFleetRole, [parameter(Mandatory = $true)] [object] $MaxvCpus, [parameter(Mandatory = $false)] [object] $Ec2Configuration, [parameter(Mandatory = $false)] [object] $BidPercentage, [parameter(Mandatory = $false)] $SecurityGroupIds, [parameter(Mandatory = $true)] $Subnets, [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] [object] $AllocationStrategy, [parameter(Mandatory = $false)] [object] $MinvCpus, [parameter(Mandatory = $false)] $LaunchTemplate, [parameter(Mandatory = $false)] [object] $ImageId, [parameter(Mandatory = $false)] [object] $InstanceRole, [parameter(Mandatory = $false)] $InstanceTypes, [parameter(Mandatory = $false)] [object] $Ec2KeyPair, [parameter(Mandatory = $false)] [object] $PlacementGroup, [parameter(Mandatory = $false)] [VSJson] $Tags, [parameter(Mandatory = $false)] [object] $DesiredvCpus ) Process { $obj = [BatchComputeEnvironmentComputeResources]::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-VSBatchComputeEnvironmentComputeResources' function Add-VSBatchComputeEnvironmentEc2ConfigurationObject { <# .SYNOPSIS Adds an AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject resource property to the template. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html .PARAMETER ImageIdOverride Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imageidoverride PrimitiveType: String UpdateType: Immutable .PARAMETER ImageType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imagetype PrimitiveType: String UpdateType: Immutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchComputeEnvironmentEc2ConfigurationObject])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ImageIdOverride, [parameter(Mandatory = $true)] [object] $ImageType ) Process { $obj = [BatchComputeEnvironmentEc2ConfigurationObject]::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-VSBatchComputeEnvironmentEc2ConfigurationObject' function Add-VSBatchComputeEnvironmentLaunchTemplateSpecification { <# .SYNOPSIS Adds an AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification resource property to the template. An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification resource property to the template. An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html .PARAMETER LaunchTemplateName The name of the launch template. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplatename PrimitiveType: String UpdateType: Immutable .PARAMETER Version The version number of the launch template. Default: The default version of the launch template. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version PrimitiveType: String UpdateType: Immutable .PARAMETER LaunchTemplateId The ID of the launch template. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplateid PrimitiveType: String UpdateType: Immutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchComputeEnvironmentLaunchTemplateSpecification])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $LaunchTemplateName, [parameter(Mandatory = $false)] [object] $Version, [parameter(Mandatory = $false)] [object] $LaunchTemplateId ) Process { $obj = [BatchComputeEnvironmentLaunchTemplateSpecification]::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-VSBatchComputeEnvironmentLaunchTemplateSpecification' function Add-VSBatchJobDefinitionContainerProperties { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.ContainerProperties resource property to the template. Container properties are used in job definitions to describe the container that is launched as part of a job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.ContainerProperties resource property to the template. Container properties are used in job definitions to describe the container that is launched as part of a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --user option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user PrimitiveType: String UpdateType: Mutable .PARAMETER Secrets *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-secrets ItemType: Secret UpdateType: Mutable .PARAMETER Memory The hard limit in MiB of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --memory option to docker run: https://docs.docker.com/engine/reference/run/. You must specify at least 4 MiB of memory for a job. If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory PrimitiveType: Integer UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --privileged option to docker run: https://docs.docker.com/engine/reference/run/. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged PrimitiveType: Boolean UpdateType: Mutable .PARAMETER LinuxParameters Linux-specific modifications that are applied to the container, such as details for device mappings. Type: LinuxParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-linuxparameters UpdateType: Mutable .PARAMETER FargatePlatformConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: FargatePlatformConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-fargateplatformconfiguration UpdateType: Mutable .PARAMETER JobRoleArn The Amazon Resource Name ARN of the IAM role that the container can assume for AWS permissions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn PrimitiveType: String UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --read-only option to docker run. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Vcpus The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container: https://docs.docker.com/engine/api/v1.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --cpu-shares option to docker run: https://docs.docker.com/engine/reference/run/. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus PrimitiveType: Integer UpdateType: Mutable .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 repository-url/image:tag . 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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the IMAGE parameter of docker run: https://docs.docker.com/engine/reference/run/. + Images in Amazon ECR repositories use the full registry and repository URI for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>. + 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-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image PrimitiveType: String UpdateType: Mutable .PARAMETER ResourceRequirements The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-resourcerequirements ItemType: ResourceRequirement UpdateType: Mutable .PARAMETER LogConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: LogConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-logconfiguration UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --volume option to docker run: https://docs.docker.com/engine/reference/run/. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints ItemType: MountPoints UpdateType: Mutable .PARAMETER ExecutionRoleArn *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-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-executionrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Volumes A list of data volumes used in a job. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes ItemType: Volumes UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ 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. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ 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. Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment ItemType: Environment UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --ulimit option to docker run: https://docs.docker.com/engine/reference/run/. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits ItemType: Ulimit UpdateType: Mutable .PARAMETER NetworkConfiguration *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: NetworkConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-networkconfiguration UpdateType: Mutable .PARAMETER InstanceType The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-instancetype PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionContainerProperties])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $User, [parameter(Mandatory = $false)] [object] $Secrets, [parameter(Mandatory = $false)] [object] $Memory, [parameter(Mandatory = $false)] [object] $Privileged, [parameter(Mandatory = $false)] $LinuxParameters, [parameter(Mandatory = $false)] $FargatePlatformConfiguration, [parameter(Mandatory = $false)] [object] $JobRoleArn, [parameter(Mandatory = $false)] [object] $ReadonlyRootFilesystem, [parameter(Mandatory = $false)] [object] $Vcpus, [parameter(Mandatory = $true)] [object] $Image, [parameter(Mandatory = $false)] [object] $ResourceRequirements, [parameter(Mandatory = $false)] $LogConfiguration, [parameter(Mandatory = $false)] [object] $MountPoints, [parameter(Mandatory = $false)] [object] $ExecutionRoleArn, [parameter(Mandatory = $false)] [object] $Volumes, [parameter(Mandatory = $false)] $Command, [parameter(Mandatory = $false)] [object] $Environment, [parameter(Mandatory = $false)] [object] $Ulimits, [parameter(Mandatory = $false)] $NetworkConfiguration, [parameter(Mandatory = $false)] [object] $InstanceType ) Process { $obj = [BatchJobDefinitionContainerProperties]::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-VSBatchJobDefinitionContainerProperties' function Add-VSBatchJobDefinitionDevice { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Device resource property to the template. An object representing a container instance host device. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Device resource property to the template. An object representing a container instance host device. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html .PARAMETER HostPath The path for the device on the host container instance. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-hostpath PrimitiveType: String UpdateType: Mutable .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. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-permissions UpdateType: Mutable .PARAMETER ContainerPath The path inside the container at which to expose the host device. By default the hostPath value is used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-containerpath PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionDevice])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $HostPath, [parameter(Mandatory = $false)] $Permissions, [parameter(Mandatory = $false)] [object] $ContainerPath ) Process { $obj = [BatchJobDefinitionDevice]::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-VSBatchJobDefinitionDevice' function Add-VSBatchJobDefinitionEnvironment { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Environment resource property to the template. The Environment property type specifies environment variables to use in a job definition. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Environment resource property to the template. The Environment property type specifies environment variables to use in a job definition. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html .PARAMETER Value The value of the environment variable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value PrimitiveType: String UpdateType: Mutable .PARAMETER Name The name of the environment variable. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionEnvironment])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Value, [parameter(Mandatory = $false)] [object] $Name ) Process { $obj = [BatchJobDefinitionEnvironment]::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-VSBatchJobDefinitionEnvironment' function Add-VSBatchJobDefinitionEvaluateOnExit { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.EvaluateOnExit resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.EvaluateOnExit resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html .PARAMETER Action Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-action PrimitiveType: String UpdateType: Mutable .PARAMETER OnExitCode Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onexitcode PrimitiveType: String UpdateType: Mutable .PARAMETER OnReason Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onreason PrimitiveType: String UpdateType: Mutable .PARAMETER OnStatusReason Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onstatusreason PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionEvaluateOnExit])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Action, [parameter(Mandatory = $false)] [object] $OnExitCode, [parameter(Mandatory = $false)] [object] $OnReason, [parameter(Mandatory = $false)] [object] $OnStatusReason ) Process { $obj = [BatchJobDefinitionEvaluateOnExit]::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-VSBatchJobDefinitionEvaluateOnExit' function Add-VSBatchJobDefinitionFargatePlatformConfiguration { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.FargatePlatformConfiguration resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.FargatePlatformConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-fargateplatformconfiguration.html .PARAMETER PlatformVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-fargateplatformconfiguration.html#cfn-batch-jobdefinition-containerproperties-fargateplatformconfiguration-platformversion PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionFargatePlatformConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $PlatformVersion ) Process { $obj = [BatchJobDefinitionFargatePlatformConfiguration]::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-VSBatchJobDefinitionFargatePlatformConfiguration' function Add-VSBatchJobDefinitionLinuxParameters { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.LinuxParameters resource property to the template. Linux-specific modifications that are applied to the container, such as details for device mappings. .DESCRIPTION Adds an AWS::Batch::JobDefinition.LinuxParameters resource property to the template. Linux-specific modifications that are applied to the container, such as details for device mappings. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html .PARAMETER Swappiness *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-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-swappiness PrimitiveType: Integer UpdateType: Mutable .PARAMETER Tmpfs *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-tmpfs ItemType: Tmpfs UpdateType: Mutable .PARAMETER SharedMemorySize *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-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-sharedmemorysize PrimitiveType: Integer UpdateType: Mutable .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.23/#create-a-container section of the Docker Remote API: https://docs.docker.com/engine/api/v1.23/ and the --device option to docker run: https://docs.docker.com/engine/reference/run/. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-devices ItemType: Device UpdateType: Mutable .PARAMETER InitProcessEnabled *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-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-initprocessenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER MaxSwap *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-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-maxswap PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionLinuxParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Swappiness, [parameter(Mandatory = $false)] [object] $Tmpfs, [parameter(Mandatory = $false)] [object] $SharedMemorySize, [parameter(Mandatory = $false)] [object] $Devices, [parameter(Mandatory = $false)] [object] $InitProcessEnabled, [parameter(Mandatory = $false)] [object] $MaxSwap ) Process { $obj = [BatchJobDefinitionLinuxParameters]::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-VSBatchJobDefinitionLinuxParameters' function Add-VSBatchJobDefinitionLogConfiguration { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.LogConfiguration resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.LogConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html .PARAMETER SecretOptions Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-secretoptions ItemType: Secret UpdateType: Mutable .PARAMETER Options Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-options PrimitiveType: Json UpdateType: Mutable .PARAMETER LogDriver Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-logdriver PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionLogConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SecretOptions, [parameter(Mandatory = $false)] [VSJson] $Options, [parameter(Mandatory = $true)] [object] $LogDriver ) Process { $obj = [BatchJobDefinitionLogConfiguration]::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-VSBatchJobDefinitionLogConfiguration' function Add-VSBatchJobDefinitionMountPoints { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.MountPoints resource property to the template. Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container section of the Docker Remote API and the --volume option to docker run. .DESCRIPTION Adds an AWS::Batch::JobDefinition.MountPoints resource property to the template. Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container section of the Docker Remote API and the --volume option to docker run. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html .PARAMETER ReadOnly If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-readonly PrimitiveType: Boolean UpdateType: Mutable .PARAMETER SourceVolume The name of the volume to mount. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-sourcevolume PrimitiveType: String UpdateType: Mutable .PARAMETER ContainerPath The path on the container at which to mount the host volume. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-containerpath PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionMountPoints])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ReadOnly, [parameter(Mandatory = $false)] [object] $SourceVolume, [parameter(Mandatory = $false)] [object] $ContainerPath ) Process { $obj = [BatchJobDefinitionMountPoints]::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-VSBatchJobDefinitionMountPoints' function Add-VSBatchJobDefinitionNetworkConfiguration { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.NetworkConfiguration resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.NetworkConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-networkconfiguration.html .PARAMETER AssignPublicIp Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-networkconfiguration.html#cfn-batch-jobdefinition-containerproperties-networkconfiguration-assignpublicip PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionNetworkConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AssignPublicIp ) Process { $obj = [BatchJobDefinitionNetworkConfiguration]::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-VSBatchJobDefinitionNetworkConfiguration' function Add-VSBatchJobDefinitionNodeProperties { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.NodeProperties resource property to the template. An object representing the node properties of a multi-node parallel job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.NodeProperties resource property to the template. An object representing the node properties of a multi-node parallel job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html .PARAMETER MainNode Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-mainnode PrimitiveType: Integer UpdateType: Mutable .PARAMETER NodeRangeProperties A list of node ranges and their properties associated with a multi-node parallel job. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-noderangeproperties ItemType: NodeRangeProperty UpdateType: Mutable .PARAMETER NumNodes The number of nodes associated with a multi-node parallel job. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-numnodes PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionNodeProperties])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $MainNode, [parameter(Mandatory = $true)] [object] $NodeRangeProperties, [parameter(Mandatory = $true)] [object] $NumNodes ) Process { $obj = [BatchJobDefinitionNodeProperties]::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-VSBatchJobDefinitionNodeProperties' function Add-VSBatchJobDefinitionNodeRangeProperty { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.NodeRangeProperty resource property to the template. An object representing the properties of the node range for a multi-node parallel job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.NodeRangeProperty resource property to the template. An object representing the properties of the node range for a multi-node parallel job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html .PARAMETER Container The container details for the node range. Type: ContainerProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-container UpdateType: Mutable .PARAMETER TargetNodes The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted :n, then 0 is used to start the range. If the ending range value is omitted n:, then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes 0:n. You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-targetnodes PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionNodeRangeProperty])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Container, [parameter(Mandatory = $true)] [object] $TargetNodes ) Process { $obj = [BatchJobDefinitionNodeRangeProperty]::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-VSBatchJobDefinitionNodeRangeProperty' function Add-VSBatchJobDefinitionResourceRequirement { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.ResourceRequirement resource property to the template. The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU. .DESCRIPTION Adds an AWS::Batch::JobDefinition.ResourceRequirement resource property to the template. The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html .PARAMETER Type The type of resource to assign to a container. Currently, the only supported resource type is GPU. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-type PrimitiveType: String UpdateType: Mutable .PARAMETER Value The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionResourceRequirement])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Type, [parameter(Mandatory = $false)] [object] $Value ) Process { $obj = [BatchJobDefinitionResourceRequirement]::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-VSBatchJobDefinitionResourceRequirement' function Add-VSBatchJobDefinitionRetryStrategy { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.RetryStrategy resource property to the template. The retry strategy associated with a job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.RetryStrategy resource property to the template. The retry strategy associated with a job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html .PARAMETER EvaluateOnExit *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-evaluateonexit ItemType: EvaluateOnExit UpdateType: Mutable .PARAMETER Attempts The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionRetryStrategy])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $EvaluateOnExit, [parameter(Mandatory = $false)] [object] $Attempts ) Process { $obj = [BatchJobDefinitionRetryStrategy]::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-VSBatchJobDefinitionRetryStrategy' function Add-VSBatchJobDefinitionSecret { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Secret resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Secret resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html .PARAMETER ValueFrom Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-valuefrom PrimitiveType: String UpdateType: Mutable .PARAMETER Name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionSecret])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ValueFrom, [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [BatchJobDefinitionSecret]::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-VSBatchJobDefinitionSecret' function Add-VSBatchJobDefinitionTimeout { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Timeout resource property to the template. An object representing a job timeout configuration. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Timeout resource property to the template. An object representing a job timeout configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html .PARAMETER AttemptDurationSeconds The time duration in seconds measured from the job attempt's startedAt timestamp after which AWS Batch terminates your jobs if they have not finished. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html#cfn-batch-jobdefinition-timeout-attemptdurationseconds PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionTimeout])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $AttemptDurationSeconds ) Process { $obj = [BatchJobDefinitionTimeout]::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-VSBatchJobDefinitionTimeout' function Add-VSBatchJobDefinitionTmpfs { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Tmpfs resource property to the template. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Tmpfs resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html .PARAMETER Size Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-size PrimitiveType: Integer UpdateType: Mutable .PARAMETER ContainerPath Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-containerpath PrimitiveType: String UpdateType: Mutable .PARAMETER MountOptions PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-mountoptions UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionTmpfs])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Size, [parameter(Mandatory = $true)] [object] $ContainerPath, [parameter(Mandatory = $false)] $MountOptions ) Process { $obj = [BatchJobDefinitionTmpfs]::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-VSBatchJobDefinitionTmpfs' function Add-VSBatchJobDefinitionUlimit { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Ulimit resource property to the template. The ulimit settings to pass to the container. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Ulimit resource property to the template. The ulimit settings to pass to the container. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html .PARAMETER SoftLimit The soft limit for the ulimit type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER HardLimit The hard limit for the ulimit type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit PrimitiveType: Integer UpdateType: Mutable .PARAMETER Name The type of the ulimit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionUlimit])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $SoftLimit, [parameter(Mandatory = $true)] [object] $HardLimit, [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [BatchJobDefinitionUlimit]::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-VSBatchJobDefinitionUlimit' function Add-VSBatchJobDefinitionVolumes { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.Volumes resource property to the template. A list of volumes associated with the job. .DESCRIPTION Adds an AWS::Batch::JobDefinition.Volumes resource property to the template. A list of volumes associated with the job. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html .PARAMETER Host The contents of the host parameter determine whether your data 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. Type: VolumesHost Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-host UpdateType: Mutable .PARAMETER Name The name of the volume. Up to 255 letters uppercase and lowercase, numbers, hyphens, and underscores 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-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionVolumes])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Host, [parameter(Mandatory = $false)] [object] $Name ) Process { $obj = [BatchJobDefinitionVolumes]::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-VSBatchJobDefinitionVolumes' function Add-VSBatchJobDefinitionVolumesHost { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition.VolumesHost resource property to the template. Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. .DESCRIPTION Adds an AWS::Batch::JobDefinition.VolumesHost resource property to the template. Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html .PARAMETER SourcePath 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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobDefinitionVolumesHost])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $SourcePath ) Process { $obj = [BatchJobDefinitionVolumesHost]::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-VSBatchJobDefinitionVolumesHost' function Add-VSBatchJobQueueComputeEnvironmentOrder { <# .SYNOPSIS Adds an AWS::Batch::JobQueue.ComputeEnvironmentOrder resource property to the template. The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. .DESCRIPTION Adds an AWS::Batch::JobQueue.ComputeEnvironmentOrder resource property to the template. The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html .PARAMETER ComputeEnvironment The Amazon Resource Name ARN of the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-computeenvironment PrimitiveType: String UpdateType: Mutable .PARAMETER Order The order of the compute environment. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-order PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([BatchJobQueueComputeEnvironmentOrder])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ComputeEnvironment, [parameter(Mandatory = $true)] [object] $Order ) Process { $obj = [BatchJobQueueComputeEnvironmentOrder]::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-VSBatchJobQueueComputeEnvironmentOrder' function New-VSBatchComputeEnvironment { <# .SYNOPSIS Adds an AWS::Batch::ComputeEnvironment resource to the template. The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .DESCRIPTION Adds an AWS::Batch::ComputeEnvironment resource to the template. The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.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 Type The type of the compute environment. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-type PrimitiveType: String UpdateType: Immutable .PARAMETER ServiceRole The full Amazon Resource Name ARN of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. 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. Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole PrimitiveType: String UpdateType: Mutable .PARAMETER ComputeEnvironmentName The name for your compute environment. Up to 128 letters uppercase and lowercase, numbers, hyphens, and underscores are allowed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeenvironmentname PrimitiveType: String UpdateType: Immutable .PARAMETER ComputeResources The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. Type: ComputeResources Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeresources UpdateType: Mutable .PARAMETER State The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-state PrimitiveType: String UpdateType: Mutable .PARAMETER Tags + Compute Environments: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-tags PrimitiveType: Json UpdateType: Immutable .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([BatchComputeEnvironment])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $true)] [object] $ServiceRole, [parameter(Mandatory = $false)] [object] $ComputeEnvironmentName, [parameter(Mandatory = $false)] $ComputeResources, [parameter(Mandatory = $false)] [object] $State, [parameter(Mandatory = $false)] [VSJson] $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 = [BatchComputeEnvironment]::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-VSBatchComputeEnvironment' function New-VSBatchJobDefinition { <# .SYNOPSIS Adds an AWS::Batch::JobDefinition resource to the template. The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions: https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html in the *AWS Batch User Guide*. .DESCRIPTION Adds an AWS::Batch::JobDefinition resource to the template. The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions: https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.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 Type The type of job definition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters PrimitiveType: Json UpdateType: Mutable .PARAMETER NodeProperties An object with various properties specific to multi-node parallel jobs. Type: NodeProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties UpdateType: Mutable .PARAMETER Timeout The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. Type: Timeout Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout UpdateType: Mutable .PARAMETER ContainerProperties An object with various properties specific to container-based jobs. Type: ContainerProperties Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties UpdateType: Mutable .PARAMETER JobDefinitionName The name of the job definition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname PrimitiveType: String UpdateType: Immutable .PARAMETER PropagateTags + Job Definition Parameters: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-propagatetags PrimitiveType: Boolean UpdateType: Mutable .PARAMETER PlatformCapabilities + Job Definition Parameters: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html in the *AWS Batch User Guide*. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-platformcapabilities UpdateType: Mutable .PARAMETER RetryStrategy The retry strategy to use for failed jobs that are submitted with this job definition. Type: RetryStrategy Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy UpdateType: Mutable .PARAMETER Tags + Job Definition Parameters: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html in the *AWS Batch User Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-tags PrimitiveType: Json UpdateType: Immutable .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([BatchJobDefinition])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] [VSJson] $Parameters, [parameter(Mandatory = $false)] $NodeProperties, [parameter(Mandatory = $false)] $Timeout, [parameter(Mandatory = $false)] $ContainerProperties, [parameter(Mandatory = $false)] [object] $JobDefinitionName, [parameter(Mandatory = $false)] [object] $PropagateTags, [parameter(Mandatory = $false)] $PlatformCapabilities, [parameter(Mandatory = $false)] $RetryStrategy, [parameter(Mandatory = $false)] [VSJson] $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 = [BatchJobDefinition]::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-VSBatchJobDefinition' function New-VSBatchJobQueue { <# .SYNOPSIS Adds an AWS::Batch::JobQueue resource to the template. The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues: https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html in the *AWS Batch User Guide*. .DESCRIPTION Adds an AWS::Batch::JobQueue resource to the template. The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues: https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html in the *AWS Batch User Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.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 ComputeEnvironmentOrder The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder ItemType: ComputeEnvironmentOrder UpdateType: Mutable .PARAMETER Priority The priority of the job queue. Job queues with a higher priority or a higher integer value for the priority parameter are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER State The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state PrimitiveType: String UpdateType: Mutable .PARAMETER JobQueueName The name of the job queue. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename PrimitiveType: String UpdateType: Immutable .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-tags PrimitiveType: Json UpdateType: Immutable .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([BatchJobQueue])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $ComputeEnvironmentOrder, [parameter(Mandatory = $true)] [object] $Priority, [parameter(Mandatory = $false)] [object] $State, [parameter(Mandatory = $false)] [object] $JobQueueName, [parameter(Mandatory = $false)] [VSJson] $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 = [BatchJobQueue]::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-VSBatchJobQueue' |