VaporShell.S3.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-VSS3AccessPointPublicAccessBlockConfiguration { <# .SYNOPSIS Adds an AWS::S3::AccessPoint.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::AccessPoint.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html .PARAMETER BlockPublicAcls Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: + PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicacls UpdateType: Immutable PrimitiveType: Boolean .PARAMETER IgnorePublicAcls Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-ignorepublicacls UpdateType: Immutable PrimitiveType: Boolean .PARAMETER BlockPublicPolicy Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicpolicy UpdateType: Immutable PrimitiveType: Boolean .PARAMETER RestrictPublicBuckets Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets UpdateType: Immutable PrimitiveType: Boolean .FUNCTIONALITY Vaporshell #> [OutputType([S3AccessPointPublicAccessBlockConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BlockPublicAcls, [parameter(Mandatory = $false)] [object] $IgnorePublicAcls, [parameter(Mandatory = $false)] [object] $BlockPublicPolicy, [parameter(Mandatory = $false)] [object] $RestrictPublicBuckets ) Process { $obj = [S3AccessPointPublicAccessBlockConfiguration]::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-VSS3AccessPointPublicAccessBlockConfiguration' function Add-VSS3AccessPointVpcConfiguration { <# .SYNOPSIS Adds an AWS::S3::AccessPoint.VpcConfiguration resource property to the template. The Virtual Private Cloud (VPC configuration for this access point. .DESCRIPTION Adds an AWS::S3::AccessPoint.VpcConfiguration resource property to the template. The Virtual Private Cloud (VPC configuration for this access point. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html .PARAMETER VpcId If this field is specified, the access point will only allow connections from the specified VPC ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html#cfn-s3-accesspoint-vpcconfiguration-vpcid UpdateType: Immutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([S3AccessPointVpcConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $VpcId ) Process { $obj = [S3AccessPointVpcConfiguration]::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-VSS3AccessPointVpcConfiguration' function Add-VSS3BucketAbortIncompleteMultipartUpload { <# .SYNOPSIS Adds an AWS::S3::Bucket.AbortIncompleteMultipartUpload resource property to the template. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.AbortIncompleteMultipartUpload resource property to the template. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html .PARAMETER DaysAfterInitiation Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html#cfn-s3-bucket-abortincompletemultipartupload-daysafterinitiation PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketAbortIncompleteMultipartUpload])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $DaysAfterInitiation ) Process { $obj = [S3BucketAbortIncompleteMultipartUpload]::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-VSS3BucketAbortIncompleteMultipartUpload' function Add-VSS3BucketAccelerateConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.AccelerateConfiguration resource property to the template. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.AccelerateConfiguration resource property to the template. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html .PARAMETER AccelerationStatus Specifies the transfer acceleration status of the bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html#cfn-s3-bucket-accelerateconfiguration-accelerationstatus PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketAccelerateConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $AccelerationStatus ) Process { $obj = [S3BucketAccelerateConfiguration]::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-VSS3BucketAccelerateConfiguration' function Add-VSS3BucketAccessControlTranslation { <# .SYNOPSIS Adds an AWS::S3::Bucket.AccessControlTranslation resource property to the template. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. .DESCRIPTION Adds an AWS::S3::Bucket.AccessControlTranslation resource property to the template. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html .PARAMETER Owner Specifies the replica ownership. For default and valid values, see PUT bucket replication: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html in the *Amazon Simple Storage Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html#cfn-s3-bucket-accesscontroltranslation-owner PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketAccessControlTranslation])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Owner ) Process { $obj = [S3BucketAccessControlTranslation]::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-VSS3BucketAccessControlTranslation' function Add-VSS3BucketAnalyticsConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.AnalyticsConfiguration resource property to the template. Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html .PARAMETER Id The ID that identifies the analytics configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix The prefix that an object must have to be included in the analytics results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER StorageClassAnalysis Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis Type: StorageClassAnalysis UpdateType: Mutable .PARAMETER TagFilters The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters DuplicatesAllowed: False ItemType: TagFilter Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketAnalyticsConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $true)] $StorageClassAnalysis, [parameter(Mandatory = $false)] [object] $TagFilters ) Process { $obj = [S3BucketAnalyticsConfiguration]::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-VSS3BucketAnalyticsConfiguration' function Add-VSS3BucketBucketEncryption { <# .SYNOPSIS Adds an AWS::S3::Bucket.BucketEncryption resource property to the template. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3 or AWS KMS-managed keys (SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.BucketEncryption resource property to the template. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3 or AWS KMS-managed keys (SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html .PARAMETER ServerSideEncryptionConfiguration Specifies the default server-side-encryption configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html#cfn-s3-bucket-bucketencryption-serversideencryptionconfiguration DuplicatesAllowed: False ItemType: ServerSideEncryptionRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketBucketEncryption])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ServerSideEncryptionConfiguration ) Process { $obj = [S3BucketBucketEncryption]::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-VSS3BucketBucketEncryption' function Add-VSS3BucketCorsConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.CorsConfiguration resource property to the template. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.CorsConfiguration resource property to the template. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html .PARAMETER CorsRules A set of origins and methods cross-origin access that you want to allow. You can add up to 100 rules to the configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html#cfn-s3-bucket-cors-corsrule DuplicatesAllowed: False ItemType: CorsRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketCorsConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $CorsRules ) Process { $obj = [S3BucketCorsConfiguration]::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-VSS3BucketCorsConfiguration' function Add-VSS3BucketCorsRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.CorsRule resource property to the template. Specifies a cross-origin access rule for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.CorsRule resource property to the template. Specifies a cross-origin access rule for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html .PARAMETER AllowedHeaders Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedheaders DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER AllowedMethods An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedmethods DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER AllowedOrigins One or more origins you want customers to be able to access the bucket from. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedorigins DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER ExposedHeaders One or more headers in the response that you want customers to be able to access from their applications for example, from a JavaScript XMLHttpRequest object. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-exposedheaders DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER Id A unique identifier for this rule. The value must be no more than 255 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-id PrimitiveType: String UpdateType: Mutable .PARAMETER MaxAge The time in seconds that your browser is to cache the preflight response for the specified resource. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-maxage PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketCorsRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $AllowedHeaders, [parameter(Mandatory = $true)] $AllowedMethods, [parameter(Mandatory = $true)] $AllowedOrigins, [parameter(Mandatory = $false)] $ExposedHeaders, [parameter(Mandatory = $false)] [object] $Id, [parameter(Mandatory = $false)] [object] $MaxAge ) Process { $obj = [S3BucketCorsRule]::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-VSS3BucketCorsRule' function Add-VSS3BucketDataExport { <# .SYNOPSIS Adds an AWS::S3::Bucket.DataExport resource property to the template. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. .DESCRIPTION Adds an AWS::S3::Bucket.DataExport resource property to the template. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html .PARAMETER Destination The place to store the data for an analysis. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-destination Type: Destination UpdateType: Mutable .PARAMETER OutputSchemaVersion The version of the output schema to use when exporting data. Must be V_1. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-outputschemaversion PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketDataExport])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Destination, [parameter(Mandatory = $true)] [object] $OutputSchemaVersion ) Process { $obj = [S3BucketDataExport]::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-VSS3BucketDataExport' function Add-VSS3BucketDefaultRetention { <# .SYNOPSIS Adds an AWS::S3::Bucket.DefaultRetention resource property to the template. The default retention period that you want to apply to new objects placed in the specified bucket. .DESCRIPTION Adds an AWS::S3::Bucket.DefaultRetention resource property to the template. The default retention period that you want to apply to new objects placed in the specified bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html .PARAMETER Days The number of days that you want to specify for the default retention period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-days PrimitiveType: Integer UpdateType: Mutable .PARAMETER Mode The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode PrimitiveType: String UpdateType: Mutable .PARAMETER Years The number of years that you want to specify for the default retention period. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-years PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketDefaultRetention])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Days, [parameter(Mandatory = $false)] [object] $Mode, [parameter(Mandatory = $false)] [object] $Years ) Process { $obj = [S3BucketDefaultRetention]::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-VSS3BucketDefaultRetention' function Add-VSS3BucketDeleteMarkerReplication { <# .SYNOPSIS Adds an AWS::S3::Bucket.DeleteMarkerReplication resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.DeleteMarkerReplication resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html#cfn-s3-bucket-deletemarkerreplication-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketDeleteMarkerReplication])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Status ) Process { $obj = [S3BucketDeleteMarkerReplication]::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-VSS3BucketDeleteMarkerReplication' function Add-VSS3BucketDestination { <# .SYNOPSIS Adds an AWS::S3::Bucket.Destination resource property to the template. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC. .DESCRIPTION Adds an AWS::S3::Bucket.Destination resource property to the template. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html .PARAMETER BucketAccountId The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid PrimitiveType: String UpdateType: Mutable .PARAMETER BucketArn The Amazon Resource Name ARN of the bucket to which data is exported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn PrimitiveType: String UpdateType: Mutable .PARAMETER Format Specifies the file format used when exporting data to Amazon S3. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix The prefix to use when exporting data. The prefix is prepended to all results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketDestination])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BucketAccountId, [parameter(Mandatory = $true)] [object] $BucketArn, [parameter(Mandatory = $true)] [object] $Format, [parameter(Mandatory = $false)] [object] $Prefix ) Process { $obj = [S3BucketDestination]::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-VSS3BucketDestination' function Add-VSS3BucketEncryptionConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.EncryptionConfiguration resource property to the template. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. .DESCRIPTION Adds an AWS::S3::Bucket.EncryptionConfiguration resource property to the template. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html .PARAMETER ReplicaKmsKeyID Specifies the ID Key ARN or Alias ARN of the customer managed customer master key CMK stored in AWS Key Management Service KMS for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs. For more information, see Using Symmetric and Asymmetric Keys: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html in the *AWS Key Management Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketEncryptionConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $ReplicaKmsKeyID ) Process { $obj = [S3BucketEncryptionConfiguration]::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-VSS3BucketEncryptionConfiguration' function Add-VSS3BucketFilterRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.FilterRule resource property to the template. Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name. .DESCRIPTION Adds an AWS::S3::Bucket.FilterRule resource property to the template. Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html .PARAMETER Name The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-name PrimitiveType: String UpdateType: Mutable .PARAMETER Value The value that the filter searches for in object key names. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketFilterRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Name, [parameter(Mandatory = $true)] [object] $Value ) Process { $obj = [S3BucketFilterRule]::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-VSS3BucketFilterRule' function Add-VSS3BucketIntelligentTieringConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.IntelligentTieringConfiguration resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.IntelligentTieringConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html .PARAMETER Id Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-status PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tagfilters DuplicatesAllowed: False ItemType: TagFilter Type: List UpdateType: Mutable .PARAMETER Tierings Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tierings DuplicatesAllowed: False ItemType: Tiering Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketIntelligentTieringConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $true)] [object] $Status, [parameter(Mandatory = $false)] [object] $TagFilters, [parameter(Mandatory = $true)] [object] $Tierings ) Process { $obj = [S3BucketIntelligentTieringConfiguration]::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-VSS3BucketIntelligentTieringConfiguration' function Add-VSS3BucketInventoryConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.InventoryConfiguration resource property to the template. Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.InventoryConfiguration resource property to the template. Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html .PARAMETER Destination Contains information about where to publish the inventory results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination Type: Destination UpdateType: Mutable .PARAMETER Enabled Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Id The ID used to identify the inventory configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER IncludedObjectVersions Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions PrimitiveType: String UpdateType: Mutable .PARAMETER OptionalFields Contains the optional fields that are included in the inventory results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields DuplicatesAllowed: False PrimitiveItemType: String Type: List UpdateType: Mutable .PARAMETER Prefix The prefix that is prepended to all inventory results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER ScheduleFrequency Specifies the schedule for generating inventory results. Valid Values: Daily | Weekly. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketInventoryConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $Destination, [parameter(Mandatory = $true)] [object] $Enabled, [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $true)] [object] $IncludedObjectVersions, [parameter(Mandatory = $false)] $OptionalFields, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $true)] [object] $ScheduleFrequency ) Process { $obj = [S3BucketInventoryConfiguration]::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-VSS3BucketInventoryConfiguration' function Add-VSS3BucketLambdaConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.LambdaConfiguration resource property to the template. Describes the AWS Lambda functions to invoke and the events for which to invoke them. .DESCRIPTION Adds an AWS::S3::Bucket.LambdaConfiguration resource property to the template. Describes the AWS Lambda functions to invoke and the events for which to invoke them. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html .PARAMETER Event The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a .jpg extension invoke the function when they are added to the Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Function The Amazon Resource Name ARN of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-function PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketLambdaConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Event, [parameter(Mandatory = $false)] $Filter, [parameter(Mandatory = $true)] [object] $Function ) Process { $obj = [S3BucketLambdaConfiguration]::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-VSS3BucketLambdaConfiguration' function Add-VSS3BucketLifecycleConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.LifecycleConfiguration resource property to the template. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.LifecycleConfiguration resource property to the template. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html .PARAMETER Rules A lifecycle rule for individual objects in an Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html#cfn-s3-bucket-lifecycleconfig-rules DuplicatesAllowed: False ItemType: Rule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketLifecycleConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Rules ) Process { $obj = [S3BucketLifecycleConfiguration]::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-VSS3BucketLifecycleConfiguration' function Add-VSS3BucketLoggingConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.LoggingConfiguration resource property to the template. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.LoggingConfiguration resource property to the template. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html .PARAMETER DestinationBucketName The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-destinationbucketname PrimitiveType: String UpdateType: Mutable .PARAMETER LogFilePrefix A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-logfileprefix PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketLoggingConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $DestinationBucketName, [parameter(Mandatory = $false)] [object] $LogFilePrefix ) Process { $obj = [S3BucketLoggingConfiguration]::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-VSS3BucketLoggingConfiguration' function Add-VSS3BucketMetrics { <# .SYNOPSIS Adds an AWS::S3::Bucket.Metrics resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.Metrics resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html .PARAMETER EventThreshold Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-eventthreshold Type: ReplicationTimeValue UpdateType: Mutable .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketMetrics])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $EventThreshold, [parameter(Mandatory = $true)] [object] $Status ) Process { $obj = [S3BucketMetrics]::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-VSS3BucketMetrics' function Add-VSS3BucketMetricsConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.MetricsConfiguration resource property to the template. Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.MetricsConfiguration resource property to the template. Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html .PARAMETER Id The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix The prefix that an object must have to be included in the metrics results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters DuplicatesAllowed: False ItemType: TagFilter Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketMetricsConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] [object] $TagFilters ) Process { $obj = [S3BucketMetricsConfiguration]::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-VSS3BucketMetricsConfiguration' function Add-VSS3BucketNoncurrentVersionTransition { <# .SYNOPSIS Adds an AWS::S3::Bucket.NoncurrentVersionTransition resource property to the template. Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended, you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime. .DESCRIPTION Adds an AWS::S3::Bucket.NoncurrentVersionTransition resource property to the template. Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended, you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html .PARAMETER StorageClass The class of storage used to store the object. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-storageclass PrimitiveType: String UpdateType: Mutable .PARAMETER TransitionInDays Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-transitionindays PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketNoncurrentVersionTransition])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $StorageClass, [parameter(Mandatory = $true)] [object] $TransitionInDays ) Process { $obj = [S3BucketNoncurrentVersionTransition]::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-VSS3BucketNoncurrentVersionTransition' function Add-VSS3BucketNotificationConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.NotificationConfiguration resource property to the template. Describes the notification configuration for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.NotificationConfiguration resource property to the template. Describes the notification configuration for an Amazon S3 bucket. **Note** If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the AWS::Lambda::Permission resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function. If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see AWS::Lambda::Permission: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html and Granting Permissions to Publish Event Notification Messages to a Destination: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html .PARAMETER LambdaConfigurations Describes the AWS Lambda functions to invoke and the events for which to invoke them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig DuplicatesAllowed: False ItemType: LambdaConfiguration Type: List UpdateType: Mutable .PARAMETER QueueConfigurations The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-queueconfig DuplicatesAllowed: False ItemType: QueueConfiguration Type: List UpdateType: Mutable .PARAMETER TopicConfigurations The topic to which notifications are sent and the events for which notifications are generated. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-topicconfig DuplicatesAllowed: False ItemType: TopicConfiguration Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketNotificationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $LambdaConfigurations, [parameter(Mandatory = $false)] [object] $QueueConfigurations, [parameter(Mandatory = $false)] [object] $TopicConfigurations ) Process { $obj = [S3BucketNotificationConfiguration]::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-VSS3BucketNotificationConfiguration' function Add-VSS3BucketNotificationFilter { <# .SYNOPSIS Adds an AWS::S3::Bucket.NotificationFilter resource property to the template. Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.NotificationFilter resource property to the template. Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html .PARAMETER S3Key A container for object key name prefix and suffix filtering rules. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key Type: S3KeyFilter UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketNotificationFilter])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $S3Key ) Process { $obj = [S3BucketNotificationFilter]::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-VSS3BucketNotificationFilter' function Add-VSS3BucketObjectLockConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockConfiguration resource property to the template. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. **Note** DefaultRetention requires either Days or Years. You can't specify both at the same time. **Related Resources** + Locking Objects: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html .PARAMETER ObjectLockEnabled Indicates whether this bucket has an Object Lock configuration enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled PrimitiveType: String UpdateType: Mutable .PARAMETER Rule The Object Lock rule in place for the specified object. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule Type: ObjectLockRule UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketObjectLockConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ObjectLockEnabled, [parameter(Mandatory = $false)] $Rule ) Process { $obj = [S3BucketObjectLockConfiguration]::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-VSS3BucketObjectLockConfiguration' function Add-VSS3BucketObjectLockRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. The Object Lock rule in place for the specified object. .DESCRIPTION Adds an AWS::S3::Bucket.ObjectLockRule resource property to the template. The Object Lock rule in place for the specified object. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html .PARAMETER DefaultRetention The default retention period that you want to apply to new objects placed in the specified bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html#cfn-s3-bucket-objectlockrule-defaultretention Type: DefaultRetention UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketObjectLockRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $DefaultRetention ) Process { $obj = [S3BucketObjectLockRule]::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-VSS3BucketObjectLockRule' function Add-VSS3BucketOwnershipControls { <# .SYNOPSIS Adds an AWS::S3::Bucket.OwnershipControls resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.OwnershipControls resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html .PARAMETER Rules Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html#cfn-s3-bucket-ownershipcontrols-rules DuplicatesAllowed: False ItemType: OwnershipControlsRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketOwnershipControls])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Rules ) Process { $obj = [S3BucketOwnershipControls]::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-VSS3BucketOwnershipControls' function Add-VSS3BucketOwnershipControlsRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.OwnershipControlsRule resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.OwnershipControlsRule resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html .PARAMETER ObjectOwnership Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html#cfn-s3-bucket-ownershipcontrolsrule-objectownership PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketOwnershipControlsRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ObjectOwnership ) Process { $obj = [S3BucketOwnershipControlsRule]::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-VSS3BucketOwnershipControlsRule' function Add-VSS3BucketPublicAccessBlockConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the Amazon Simple Storage Service Developer Guide. .DESCRIPTION Adds an AWS::S3::Bucket.PublicAccessBlockConfiguration resource property to the template. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the Amazon Simple Storage Service Developer Guide. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html .PARAMETER BlockPublicAcls Specifies whether Amazon S3 should block public access control lists ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: + PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicacls PrimitiveType: Boolean UpdateType: Mutable .PARAMETER BlockPublicPolicy Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicpolicy PrimitiveType: Boolean UpdateType: Mutable .PARAMETER IgnorePublicAcls Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-ignorepublicacls PrimitiveType: Boolean UpdateType: Mutable .PARAMETER RestrictPublicBuckets Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-restrictpublicbuckets PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketPublicAccessBlockConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BlockPublicAcls, [parameter(Mandatory = $false)] [object] $BlockPublicPolicy, [parameter(Mandatory = $false)] [object] $IgnorePublicAcls, [parameter(Mandatory = $false)] [object] $RestrictPublicBuckets ) Process { $obj = [S3BucketPublicAccessBlockConfiguration]::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-VSS3BucketPublicAccessBlockConfiguration' function Add-VSS3BucketQueueConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.QueueConfiguration resource property to the template. Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS queue when Amazon S3 detects specified events. .DESCRIPTION Adds an AWS::S3::Bucket.QueueConfiguration resource property to the template. Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS queue when Amazon S3 detects specified events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html .PARAMETER Event The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Queue The Amazon Resource Name ARN of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-queue PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketQueueConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Event, [parameter(Mandatory = $false)] $Filter, [parameter(Mandatory = $true)] [object] $Queue ) Process { $obj = [S3BucketQueueConfiguration]::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-VSS3BucketQueueConfiguration' function Add-VSS3BucketRedirectAllRequestsTo { <# .SYNOPSIS Adds an AWS::S3::Bucket.RedirectAllRequestsTo resource property to the template. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.RedirectAllRequestsTo resource property to the template. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html .PARAMETER HostName Name of the host where requests are redirected. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-hostname PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol Protocol to use when redirecting requests. The default is the protocol that is used in the original request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-protocol PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketRedirectAllRequestsTo])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $HostName, [parameter(Mandatory = $false)] [object] $Protocol ) Process { $obj = [S3BucketRedirectAllRequestsTo]::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-VSS3BucketRedirectAllRequestsTo' function Add-VSS3BucketRedirectRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.RedirectRule resource property to the template. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return. .DESCRIPTION Adds an AWS::S3::Bucket.RedirectRule resource property to the template. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html .PARAMETER HostName The host name to use in the redirect request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-hostname PrimitiveType: String UpdateType: Mutable .PARAMETER HttpRedirectCode The HTTP redirect code to use on the response. Not required if one of the siblings is present. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-httpredirectcode PrimitiveType: String UpdateType: Mutable .PARAMETER Protocol Protocol to use when redirecting requests. The default is the protocol that is used in the original request. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-protocol PrimitiveType: String UpdateType: Mutable .PARAMETER ReplaceKeyPrefixWith The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ objects in the docs/ folder to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeyprefixwith PrimitiveType: String UpdateType: Mutable .PARAMETER ReplaceKeyWith The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeywith PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketRedirectRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $HostName, [parameter(Mandatory = $false)] [object] $HttpRedirectCode, [parameter(Mandatory = $false)] [object] $Protocol, [parameter(Mandatory = $false)] [object] $ReplaceKeyPrefixWith, [parameter(Mandatory = $false)] [object] $ReplaceKeyWith ) Process { $obj = [S3BucketRedirectRule]::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-VSS3BucketRedirectRule' function Add-VSS3BucketReplicaModifications { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicaModifications resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicaModifications resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html#cfn-s3-bucket-replicamodifications-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicaModifications])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Status ) Process { $obj = [S3BucketReplicaModifications]::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-VSS3BucketReplicaModifications' function Add-VSS3BucketReplicationConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationConfiguration resource property to the template. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationConfiguration resource property to the template. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html .PARAMETER Role The Amazon Resource Name ARN of the AWS Identity and Access Management IAM role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role PrimitiveType: String UpdateType: Mutable .PARAMETER Rules A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-rules DuplicatesAllowed: False ItemType: ReplicationRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Role, [parameter(Mandatory = $true)] [object] $Rules ) Process { $obj = [S3BucketReplicationConfiguration]::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-VSS3BucketReplicationConfiguration' function Add-VSS3BucketReplicationDestination { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationDestination resource property to the template. Specifies which Amazon S3 bucket to store replicated objects in and their storage class. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationDestination resource property to the template. Specifies which Amazon S3 bucket to store replicated objects in and their storage class. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html .PARAMETER AccessControlTranslation Specify this only in a cross-account scenario where source and destination bucket owners are not the same, and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation Type: AccessControlTranslation UpdateType: Mutable .PARAMETER Account Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Cross-Region Replication Additional Configuration: Change Replica Owner: https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html in the *Amazon Simple Storage Service Developer Guide*. If you specify the AccessControlTranslation property, the Account property is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-account PrimitiveType: String UpdateType: Mutable .PARAMETER Bucket The Amazon Resource Name ARN of the bucket where you want Amazon S3 to store the results. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-bucket PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionConfiguration Specifies encryption-related information. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration Type: EncryptionConfiguration UpdateType: Mutable .PARAMETER Metrics *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-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-metrics Type: Metrics UpdateType: Mutable .PARAMETER ReplicationTime *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-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-replicationtime Type: ReplicationTime UpdateType: Mutable .PARAMETER StorageClass The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the StorageClass element of the PUT Bucket replication: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html action in the *Amazon Simple Storage Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-storageclass PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationDestination])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $AccessControlTranslation, [parameter(Mandatory = $false)] [object] $Account, [parameter(Mandatory = $true)] [object] $Bucket, [parameter(Mandatory = $false)] $EncryptionConfiguration, [parameter(Mandatory = $false)] $Metrics, [parameter(Mandatory = $false)] $ReplicationTime, [parameter(Mandatory = $false)] [object] $StorageClass ) Process { $obj = [S3BucketReplicationDestination]::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-VSS3BucketReplicationDestination' function Add-VSS3BucketReplicationRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationRule resource property to the template. Specifies which Amazon S3 objects to replicate and where to store the replicas. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationRule resource property to the template. Specifies which Amazon S3 objects to replicate and where to store the replicas. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html .PARAMETER DeleteMarkerReplication *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-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-deletemarkerreplication Type: DeleteMarkerReplication UpdateType: Mutable .PARAMETER Destination A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control S3 RTC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-destination Type: ReplicationDestination UpdateType: Mutable .PARAMETER Filter *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-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-filter Type: ReplicationRuleFilter UpdateType: Mutable .PARAMETER Id A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-id PrimitiveType: String UpdateType: Mutable .PARAMETER Prefix An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Priority *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-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-priority PrimitiveType: Integer UpdateType: Mutable .PARAMETER SourceSelectionCriteria A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key CMK stored in AWS Key Management Service SSE-KMS. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria Type: SourceSelectionCriteria UpdateType: Mutable .PARAMETER Status Specifies whether the rule is enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $DeleteMarkerReplication, [parameter(Mandatory = $true)] $Destination, [parameter(Mandatory = $false)] $Filter, [parameter(Mandatory = $false)] [object] $Id, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] [object] $Priority, [parameter(Mandatory = $false)] $SourceSelectionCriteria, [parameter(Mandatory = $true)] [object] $Status ) Process { $obj = [S3BucketReplicationRule]::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-VSS3BucketReplicationRule' function Add-VSS3BucketReplicationRuleAndOperator { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationRuleAndOperator resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationRuleAndOperator resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html .PARAMETER Prefix Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-tagfilters DuplicatesAllowed: False ItemType: TagFilter Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationRuleAndOperator])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] [object] $TagFilters ) Process { $obj = [S3BucketReplicationRuleAndOperator]::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-VSS3BucketReplicationRuleAndOperator' function Add-VSS3BucketReplicationRuleFilter { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationRuleFilter resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationRuleFilter resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html .PARAMETER And Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-and Type: ReplicationRuleAndOperator UpdateType: Mutable .PARAMETER Prefix Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-tagfilter Type: TagFilter UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationRuleFilter])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $And, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] $TagFilter ) Process { $obj = [S3BucketReplicationRuleFilter]::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-VSS3BucketReplicationRuleFilter' function Add-VSS3BucketReplicationTime { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationTime resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationTime resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html .PARAMETER Status Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-status PrimitiveType: String UpdateType: Mutable .PARAMETER Time Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-time Type: ReplicationTimeValue UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationTime])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Status, [parameter(Mandatory = $true)] $Time ) Process { $obj = [S3BucketReplicationTime]::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-VSS3BucketReplicationTime' function Add-VSS3BucketReplicationTimeValue { <# .SYNOPSIS Adds an AWS::S3::Bucket.ReplicationTimeValue resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.ReplicationTimeValue resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html .PARAMETER Minutes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html#cfn-s3-bucket-replicationtimevalue-minutes PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketReplicationTimeValue])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Minutes ) Process { $obj = [S3BucketReplicationTimeValue]::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-VSS3BucketReplicationTimeValue' function Add-VSS3BucketRoutingRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.RoutingRule resource property to the template. Specifies the redirect behavior and when a redirect is applied. .DESCRIPTION Adds an AWS::S3::Bucket.RoutingRule resource property to the template. Specifies the redirect behavior and when a redirect is applied. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html .PARAMETER RedirectRule Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-redirectrule Type: RedirectRule UpdateType: Mutable .PARAMETER RoutingRuleCondition A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition Type: RoutingRuleCondition UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketRoutingRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $RedirectRule, [parameter(Mandatory = $false)] $RoutingRuleCondition ) Process { $obj = [S3BucketRoutingRule]::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-VSS3BucketRoutingRule' function Add-VSS3BucketRoutingRuleCondition { <# .SYNOPSIS Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. .DESCRIPTION Adds an AWS::S3::Bucket.RoutingRuleCondition resource property to the template. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html .PARAMETER HttpErrorCodeReturnedEquals The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-httperrorcodereturnedequals PrimitiveType: String UpdateType: Mutable .PARAMETER KeyPrefixEquals The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-keyprefixequals PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketRoutingRuleCondition])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $HttpErrorCodeReturnedEquals, [parameter(Mandatory = $false)] [object] $KeyPrefixEquals ) Process { $obj = [S3BucketRoutingRuleCondition]::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-VSS3BucketRoutingRuleCondition' function Add-VSS3BucketRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.Rule resource property to the template. Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. For examples, see Put Bucket Lifecycle Configuration Examples: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples .DESCRIPTION Adds an AWS::S3::Bucket.Rule resource property to the template. Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html in the *Amazon Simple Storage Service API Reference*. For examples, see Put Bucket Lifecycle Configuration Examples: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html .PARAMETER AbortIncompleteMultipartUpload Specifies a lifecycle rule that aborts incomplete multipart uploads to an Amazon S3 bucket. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-abortincompletemultipartupload Type: AbortIncompleteMultipartUpload UpdateType: Mutable .PARAMETER ExpirationDate Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationdate PrimitiveType: Timestamp UpdateType: Mutable .PARAMETER ExpirationInDays Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationindays PrimitiveType: Integer UpdateType: Mutable .PARAMETER ExpiredObjectDeleteMarker *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-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-expiredobjectdeletemarker PrimitiveType: Boolean UpdateType: Mutable .PARAMETER Id Unique identifier for the rule. The value can't be longer than 255 characters. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-id PrimitiveType: String UpdateType: Mutable .PARAMETER NoncurrentVersionExpirationInDays For buckets with versioning enabled or suspended, specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversionexpirationindays PrimitiveType: Integer UpdateType: Mutable .PARAMETER NoncurrentVersionTransition Deprecated. For buckets with versioning enabled or suspended, specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the NoncurrentVersionTransitions property. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition Type: NoncurrentVersionTransition UpdateType: Mutable .PARAMETER NoncurrentVersionTransitions For buckets with versioning enabled or suspended, one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the NoncurrentVersionTransition property. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransitions DuplicatesAllowed: False ItemType: NoncurrentVersionTransition Type: List UpdateType: Mutable .PARAMETER Prefix Object key prefix that identifies one or more objects to which this rule applies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-prefix PrimitiveType: String UpdateType: Mutable .PARAMETER Status If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-status PrimitiveType: String UpdateType: Mutable .PARAMETER TagFilters Tags to use to identify a subset of objects to which the lifecycle rule applies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-tagfilters DuplicatesAllowed: False ItemType: TagFilter Type: List UpdateType: Mutable .PARAMETER Transition Deprecated. Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. If you specify this property, don't specify the Transitions property. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transition Type: Transition UpdateType: Mutable .PARAMETER Transitions One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties either in days or by date. The expiration time must also be later than the transition time. If you specify this property, don't specify the Transition property. You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transitions DuplicatesAllowed: False ItemType: Transition Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $AbortIncompleteMultipartUpload, [parameter(Mandatory = $false)] $ExpirationDate, [parameter(Mandatory = $false)] [object] $ExpirationInDays, [parameter(Mandatory = $false)] [object] $ExpiredObjectDeleteMarker, [parameter(Mandatory = $false)] [object] $Id, [parameter(Mandatory = $false)] [object] $NoncurrentVersionExpirationInDays, [parameter(Mandatory = $false)] $NoncurrentVersionTransition, [parameter(Mandatory = $false)] [object] $NoncurrentVersionTransitions, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $true)] [object] $Status, [parameter(Mandatory = $false)] [object] $TagFilters, [parameter(Mandatory = $false)] $Transition, [parameter(Mandatory = $false)] [object] $Transitions ) Process { $obj = [S3BucketRule]::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-VSS3BucketRule' function Add-VSS3BucketS3KeyFilter { <# .SYNOPSIS Adds an AWS::S3::Bucket.S3KeyFilter resource property to the template. A container for object key name prefix and suffix filtering rules. .DESCRIPTION Adds an AWS::S3::Bucket.S3KeyFilter resource property to the template. A container for object key name prefix and suffix filtering rules. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html .PARAMETER Rules A list of containers for the key-value pair that defines the criteria for the filter rule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules DuplicatesAllowed: False ItemType: FilterRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketS3KeyFilter])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Rules ) Process { $obj = [S3BucketS3KeyFilter]::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-VSS3BucketS3KeyFilter' function Add-VSS3BucketServerSideEncryptionByDefault { <# .SYNOPSIS Adds an AWS::S3::Bucket.ServerSideEncryptionByDefault resource property to the template. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.ServerSideEncryptionByDefault resource property to the template. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html .PARAMETER KMSMasterKeyID KMS key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms. You can specify the key ID or the Amazon Resource Name ARN of the CMK. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html in the *AWS Key Management Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid PrimitiveType: String UpdateType: Mutable .PARAMETER SSEAlgorithm Server-side encryption algorithm to use for the default encryption. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketServerSideEncryptionByDefault])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $KMSMasterKeyID, [parameter(Mandatory = $true)] [object] $SSEAlgorithm ) Process { $obj = [S3BucketServerSideEncryptionByDefault]::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-VSS3BucketServerSideEncryptionByDefault' function Add-VSS3BucketServerSideEncryptionRule { <# .SYNOPSIS Adds an AWS::S3::Bucket.ServerSideEncryptionRule resource property to the template. Specifies the default server-side encryption configuration. .DESCRIPTION Adds an AWS::S3::Bucket.ServerSideEncryptionRule resource property to the template. Specifies the default server-side encryption configuration. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html .PARAMETER BucketKeyEnabled *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-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-bucketkeyenabled PrimitiveType: Boolean UpdateType: Mutable .PARAMETER ServerSideEncryptionByDefault Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-serversideencryptionbydefault Type: ServerSideEncryptionByDefault UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketServerSideEncryptionRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $BucketKeyEnabled, [parameter(Mandatory = $false)] $ServerSideEncryptionByDefault ) Process { $obj = [S3BucketServerSideEncryptionRule]::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-VSS3BucketServerSideEncryptionRule' function Add-VSS3BucketSourceSelectionCriteria { <# .SYNOPSIS Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK stored in AWS Key Management Service (SSE-KMS. .DESCRIPTION Adds an AWS::S3::Bucket.SourceSelectionCriteria resource property to the template. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK stored in AWS Key Management Service (SSE-KMS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html .PARAMETER ReplicaModifications *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-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-replicamodifications Type: ReplicaModifications UpdateType: Mutable .PARAMETER SseKmsEncryptedObjects A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-ssekmsencryptedobjects Type: SseKmsEncryptedObjects UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketSourceSelectionCriteria])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ReplicaModifications, [parameter(Mandatory = $false)] $SseKmsEncryptedObjects ) Process { $obj = [S3BucketSourceSelectionCriteria]::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-VSS3BucketSourceSelectionCriteria' function Add-VSS3BucketSseKmsEncryptedObjects { <# .SYNOPSIS Adds an AWS::S3::Bucket.SseKmsEncryptedObjects resource property to the template. A container for filter information for the selection of S3 objects encrypted with AWS KMS. .DESCRIPTION Adds an AWS::S3::Bucket.SseKmsEncryptedObjects resource property to the template. A container for filter information for the selection of S3 objects encrypted with AWS KMS. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html .PARAMETER Status Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key CMK stored in AWS Key Management Service. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketSseKmsEncryptedObjects])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Status ) Process { $obj = [S3BucketSseKmsEncryptedObjects]::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-VSS3BucketSseKmsEncryptedObjects' function Add-VSS3BucketStorageClassAnalysis { <# .SYNOPSIS Adds an AWS::S3::Bucket.StorageClassAnalysis resource property to the template. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.StorageClassAnalysis resource property to the template. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html .PARAMETER DataExport Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html#cfn-s3-bucket-storageclassanalysis-dataexport Type: DataExport UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketStorageClassAnalysis])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $DataExport ) Process { $obj = [S3BucketStorageClassAnalysis]::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-VSS3BucketStorageClassAnalysis' function Add-VSS3BucketTagFilter { <# .SYNOPSIS Adds an AWS::S3::Bucket.TagFilter resource property to the template. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.TagFilter resource property to the template. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html .PARAMETER Key The tag key. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-key PrimitiveType: String UpdateType: Mutable .PARAMETER Value The tag value. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-value PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketTagFilter])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Key, [parameter(Mandatory = $true)] [object] $Value ) Process { $obj = [S3BucketTagFilter]::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-VSS3BucketTagFilter' function Add-VSS3BucketTiering { <# .SYNOPSIS Adds an AWS::S3::Bucket.Tiering resource property to the template. .DESCRIPTION Adds an AWS::S3::Bucket.Tiering resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html .PARAMETER AccessTier Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-accesstier PrimitiveType: String UpdateType: Mutable .PARAMETER Days Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-days PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketTiering])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $AccessTier, [parameter(Mandatory = $true)] [object] $Days ) Process { $obj = [S3BucketTiering]::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-VSS3BucketTiering' function Add-VSS3BucketTopicConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.TopicConfiguration resource property to the template. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS topic when Amazon S3 detects specified events. .DESCRIPTION Adds an AWS::S3::Bucket.TopicConfiguration resource property to the template. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS topic when Amazon S3 detects specified events. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html .PARAMETER Event The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-event PrimitiveType: String UpdateType: Mutable .PARAMETER Filter The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-filter Type: NotificationFilter UpdateType: Mutable .PARAMETER Topic The Amazon Resource Name ARN of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-topic PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketTopicConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Event, [parameter(Mandatory = $false)] $Filter, [parameter(Mandatory = $true)] [object] $Topic ) Process { $obj = [S3BucketTopicConfiguration]::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-VSS3BucketTopicConfiguration' function Add-VSS3BucketTransition { <# .SYNOPSIS Adds an AWS::S3::Bucket.Transition resource property to the template. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html in the *Amazon Simple Storage Service Developer Guide*. .DESCRIPTION Adds an AWS::S3::Bucket.Transition resource property to the template. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html in the *Amazon Simple Storage Service Developer Guide*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html .PARAMETER StorageClass The storage class to which you want the object to transition. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-storageclass PrimitiveType: String UpdateType: Mutable .PARAMETER TransitionDate Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitiondate PrimitiveType: Timestamp UpdateType: Mutable .PARAMETER TransitionInDays Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitionindays PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketTransition])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $StorageClass, [parameter(Mandatory = $false)] $TransitionDate, [parameter(Mandatory = $false)] [object] $TransitionInDays ) Process { $obj = [S3BucketTransition]::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-VSS3BucketTransition' function Add-VSS3BucketVersioningConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.VersioningConfiguration resource property to the template. Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html in the *Amazon Simple Storage Service API Reference*. .DESCRIPTION Adds an AWS::S3::Bucket.VersioningConfiguration resource property to the template. Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html in the *Amazon Simple Storage Service API Reference*. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html .PARAMETER Status The versioning state of the bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html#cfn-s3-bucket-versioningconfig-status PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketVersioningConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Status ) Process { $obj = [S3BucketVersioningConfiguration]::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-VSS3BucketVersioningConfiguration' function Add-VSS3BucketWebsiteConfiguration { <# .SYNOPSIS Adds an AWS::S3::Bucket.WebsiteConfiguration resource property to the template. Specifies website configuration parameters for an Amazon S3 bucket. .DESCRIPTION Adds an AWS::S3::Bucket.WebsiteConfiguration resource property to the template. Specifies website configuration parameters for an Amazon S3 bucket. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html .PARAMETER ErrorDocument The name of the error document for the website. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-errordocument PrimitiveType: String UpdateType: Mutable .PARAMETER IndexDocument The name of the index document for the website. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-indexdocument PrimitiveType: String UpdateType: Mutable .PARAMETER RedirectAllRequestsTo The redirect behavior for every request to this bucket's website endpoint. If you specify this property, you can't specify any other property. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-redirectallrequeststo Type: RedirectAllRequestsTo UpdateType: Mutable .PARAMETER RoutingRules Rules that define when a redirect is applied and the redirect behavior. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-routingrules DuplicatesAllowed: False ItemType: RoutingRule Type: List UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketWebsiteConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ErrorDocument, [parameter(Mandatory = $false)] [object] $IndexDocument, [parameter(Mandatory = $false)] $RedirectAllRequestsTo, [parameter(Mandatory = $false)] [object] $RoutingRules ) Process { $obj = [S3BucketWebsiteConfiguration]::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-VSS3BucketWebsiteConfiguration' function Add-VSS3StorageLensAccountLevel { <# .SYNOPSIS Adds an AWS::S3::StorageLens.AccountLevel resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.AccountLevel resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html .PARAMETER ActivityMetrics Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-activitymetrics UpdateType: Mutable Type: ActivityMetrics .PARAMETER BucketLevel Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-bucketlevel UpdateType: Mutable Type: BucketLevel .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensAccountLevel])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ActivityMetrics, [parameter(Mandatory = $true)] $BucketLevel ) Process { $obj = [S3StorageLensAccountLevel]::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-VSS3StorageLensAccountLevel' function Add-VSS3StorageLensActivityMetrics { <# .SYNOPSIS Adds an AWS::S3::StorageLens.ActivityMetrics resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.ActivityMetrics resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html .PARAMETER IsEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html#cfn-s3-storagelens-activitymetrics-isenabled UpdateType: Mutable PrimitiveType: Boolean .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensActivityMetrics])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IsEnabled ) Process { $obj = [S3StorageLensActivityMetrics]::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-VSS3StorageLensActivityMetrics' function Add-VSS3StorageLensAwsOrg { <# .SYNOPSIS Adds an AWS::S3::StorageLens.AwsOrg resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.AwsOrg resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html .PARAMETER Arn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html#cfn-s3-storagelens-awsorg-arn UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensAwsOrg])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Arn ) Process { $obj = [S3StorageLensAwsOrg]::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-VSS3StorageLensAwsOrg' function Add-VSS3StorageLensBucketLevel { <# .SYNOPSIS Adds an AWS::S3::StorageLens.BucketLevel resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.BucketLevel resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html .PARAMETER ActivityMetrics Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-activitymetrics UpdateType: Mutable Type: ActivityMetrics .PARAMETER PrefixLevel Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-prefixlevel UpdateType: Mutable Type: PrefixLevel .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensBucketLevel])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ActivityMetrics, [parameter(Mandatory = $false)] $PrefixLevel ) Process { $obj = [S3StorageLensBucketLevel]::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-VSS3StorageLensBucketLevel' function Add-VSS3StorageLensBucketsAndRegions { <# .SYNOPSIS Adds an AWS::S3::StorageLens.BucketsAndRegions resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.BucketsAndRegions resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html .PARAMETER Buckets Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-buckets UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .PARAMETER Regions Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-regions UpdateType: Mutable Type: List PrimitiveItemType: String DuplicatesAllowed: False .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensBucketsAndRegions])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $Buckets, [parameter(Mandatory = $false)] $Regions ) Process { $obj = [S3StorageLensBucketsAndRegions]::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-VSS3StorageLensBucketsAndRegions' function Add-VSS3StorageLensDataExport { <# .SYNOPSIS Adds an AWS::S3::StorageLens.DataExport resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.DataExport resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html .PARAMETER S3BucketDestination Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-s3bucketdestination UpdateType: Mutable Type: S3BucketDestination .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensDataExport])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $S3BucketDestination ) Process { $obj = [S3StorageLensDataExport]::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-VSS3StorageLensDataExport' function Add-VSS3StorageLensEncryption { <# .SYNOPSIS Adds an AWS::S3::StorageLens.Encryption resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.Encryption resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensEncryption])] [cmdletbinding()] Param( ) Process { $obj = [S3StorageLensEncryption]::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-VSS3StorageLensEncryption' function Add-VSS3StorageLensPrefixLevel { <# .SYNOPSIS Adds an AWS::S3::StorageLens.PrefixLevel resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.PrefixLevel resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html .PARAMETER StorageMetrics Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html#cfn-s3-storagelens-prefixlevel-storagemetrics UpdateType: Mutable Type: PrefixLevelStorageMetrics .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensPrefixLevel])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] $StorageMetrics ) Process { $obj = [S3StorageLensPrefixLevel]::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-VSS3StorageLensPrefixLevel' function Add-VSS3StorageLensPrefixLevelStorageMetrics { <# .SYNOPSIS Adds an AWS::S3::StorageLens.PrefixLevelStorageMetrics resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.PrefixLevelStorageMetrics resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html .PARAMETER IsEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-isenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER SelectionCriteria Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-selectioncriteria UpdateType: Mutable Type: SelectionCriteria .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensPrefixLevelStorageMetrics])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IsEnabled, [parameter(Mandatory = $false)] $SelectionCriteria ) Process { $obj = [S3StorageLensPrefixLevelStorageMetrics]::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-VSS3StorageLensPrefixLevelStorageMetrics' function Add-VSS3StorageLensS3BucketDestination { <# .SYNOPSIS Adds an AWS::S3::StorageLens.S3BucketDestination resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.S3BucketDestination resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html .PARAMETER OutputSchemaVersion Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-outputschemaversion UpdateType: Mutable PrimitiveType: String .PARAMETER Format Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-format UpdateType: Mutable PrimitiveType: String .PARAMETER AccountId Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-accountid UpdateType: Mutable PrimitiveType: String .PARAMETER Arn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-arn UpdateType: Mutable PrimitiveType: String .PARAMETER Prefix Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-prefix UpdateType: Mutable PrimitiveType: String .PARAMETER Encryption Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-encryption UpdateType: Mutable Type: Encryption .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensS3BucketDestination])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $OutputSchemaVersion, [parameter(Mandatory = $true)] [object] $Format, [parameter(Mandatory = $true)] [object] $AccountId, [parameter(Mandatory = $true)] [object] $Arn, [parameter(Mandatory = $false)] [object] $Prefix, [parameter(Mandatory = $false)] $Encryption ) Process { $obj = [S3StorageLensS3BucketDestination]::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-VSS3StorageLensS3BucketDestination' function Add-VSS3StorageLensSelectionCriteria { <# .SYNOPSIS Adds an AWS::S3::StorageLens.SelectionCriteria resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.SelectionCriteria resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html .PARAMETER MaxDepth Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-maxdepth UpdateType: Mutable PrimitiveType: Integer .PARAMETER Delimiter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-delimiter UpdateType: Mutable PrimitiveType: String .PARAMETER MinStorageBytesPercentage Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-minstoragebytespercentage UpdateType: Mutable PrimitiveType: Double .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensSelectionCriteria])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $MaxDepth, [parameter(Mandatory = $false)] [object] $Delimiter, [parameter(Mandatory = $false)] [object] $MinStorageBytesPercentage ) Process { $obj = [S3StorageLensSelectionCriteria]::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-VSS3StorageLensSelectionCriteria' function Add-VSS3StorageLensStorageLensConfiguration { <# .SYNOPSIS Adds an AWS::S3::StorageLens.StorageLensConfiguration resource property to the template. .DESCRIPTION Adds an AWS::S3::StorageLens.StorageLensConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html .PARAMETER Id Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-id UpdateType: Immutable PrimitiveType: String .PARAMETER Include Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-include UpdateType: Mutable Type: BucketsAndRegions .PARAMETER Exclude Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-exclude UpdateType: Mutable Type: BucketsAndRegions .PARAMETER AwsOrg Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-awsorg UpdateType: Mutable Type: AwsOrg .PARAMETER AccountLevel Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-accountlevel UpdateType: Mutable Type: AccountLevel .PARAMETER DataExport Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-dataexport UpdateType: Mutable Type: DataExport .PARAMETER IsEnabled Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-isenabled UpdateType: Mutable PrimitiveType: Boolean .PARAMETER StorageLensArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-storagelensarn UpdateType: Mutable PrimitiveType: String .FUNCTIONALITY Vaporshell #> [OutputType([S3StorageLensStorageLensConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Id, [parameter(Mandatory = $false)] $Include, [parameter(Mandatory = $false)] $Exclude, [parameter(Mandatory = $false)] $AwsOrg, [parameter(Mandatory = $true)] $AccountLevel, [parameter(Mandatory = $false)] $DataExport, [parameter(Mandatory = $true)] [object] $IsEnabled, [parameter(Mandatory = $false)] [object] $StorageLensArn ) Process { $obj = [S3StorageLensStorageLensConfiguration]::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-VSS3StorageLensStorageLensConfiguration' function New-VSS3AccessPoint { <# .SYNOPSIS Adds an AWS::S3::AccessPoint resource to the template. The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. .DESCRIPTION Adds an AWS::S3::AccessPoint resource to the template. The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.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 Name The name of this access point. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name UpdateType: Immutable PrimitiveType: String .PARAMETER Bucket The name of the bucket associated with this access point. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket UpdateType: Immutable PrimitiveType: String .PARAMETER VpcConfiguration The Virtual Private Cloud VPC configuration for this access point, if one exists. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration UpdateType: Immutable Type: VpcConfiguration .PARAMETER PublicAccessBlockConfiguration The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public": https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration UpdateType: Immutable Type: PublicAccessBlockConfiguration .PARAMETER Policy The access point policy associated with this access point. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy UpdateType: Mutable PrimitiveType: Json .PARAMETER PolicyStatus The container element for a bucket's policy status. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policystatus UpdateType: Mutable PrimitiveType: Json .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([S3AccessPoint])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $true)] [object] $Bucket, [parameter(Mandatory = $false)] $VpcConfiguration, [parameter(Mandatory = $false)] $PublicAccessBlockConfiguration, [parameter(Mandatory = $false)] [VSJson] $Policy, [parameter(Mandatory = $false)] [VSJson] $PolicyStatus, [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 = [S3AccessPoint]::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-VSS3AccessPoint' function New-VSS3Bucket { <# .SYNOPSIS Adds an AWS::S3::Bucket resource to the template. The AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. .DESCRIPTION Adds an AWS::S3::Bucket resource to the template. The AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see DeletionPolicy Attribute: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html. **Important** You can only delete empty buckets. Deletion fails for buckets that have contents. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.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 AccelerateConfiguration Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration Type: AccelerateConfiguration UpdateType: Mutable .PARAMETER AccessControl A canned access control list ACL that grants predefined permissions to the bucket. For more information about canned ACLs, see Canned ACL: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl in the *Amazon Simple Storage Service Developer Guide*. Be aware that the syntax for this property differs from the information provided in the *Amazon Simple Storage Service Developer Guide*. The AccessControl property is case-sensitive and must be one of the following values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, LogDeliveryWrite, BucketOwnerRead, BucketOwnerFullControl, or AwsExecRead. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol PrimitiveType: String UpdateType: Mutable .PARAMETER AnalyticsConfigurations Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations DuplicatesAllowed: False ItemType: AnalyticsConfiguration Type: List UpdateType: Mutable .PARAMETER BucketEncryption Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS-managed keys SSE-KMS bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-bucketencryption Type: BucketEncryption UpdateType: Mutable .PARAMETER BucketName A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. For more information, see Name Type: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. The bucket name must contain only lowercase letters, numbers, periods ., and dashes -. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name PrimitiveType: String UpdateType: Immutable .PARAMETER CorsConfiguration Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-crossoriginconfig Type: CorsConfiguration UpdateType: Mutable .PARAMETER IntelligentTieringConfigurations + Amazon S3 Template Snippets: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-s3.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-intelligenttieringconfigurations DuplicatesAllowed: False ItemType: IntelligentTieringConfiguration Type: List UpdateType: Mutable .PARAMETER InventoryConfigurations Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html in the *Amazon Simple Storage Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations DuplicatesAllowed: False ItemType: InventoryConfiguration Type: List UpdateType: Mutable .PARAMETER LifecycleConfiguration Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-lifecycleconfig Type: LifecycleConfiguration UpdateType: Mutable .PARAMETER LoggingConfiguration Settings that define where logs are stored. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-loggingconfig Type: LoggingConfiguration UpdateType: Mutable .PARAMETER MetricsConfigurations Specifies a metrics configuration for the CloudWatch request metrics specified by the metrics configuration ID from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html in the *Amazon Simple Storage Service API Reference*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-metricsconfigurations DuplicatesAllowed: False ItemType: MetricsConfiguration Type: List UpdateType: Mutable .PARAMETER NotificationConfiguration Configuration that defines how Amazon S3 handles bucket notifications. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-notification Type: NotificationConfiguration UpdateType: Mutable .PARAMETER ObjectLockConfiguration Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. DefaultRetention requires either Days or Years. You can't specify both at the same time. **Related Resources** + Locking Objects: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration Type: ObjectLockConfiguration UpdateType: Mutable .PARAMETER ObjectLockEnabled Indicates whether this bucket has an Object Lock configuration enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled PrimitiveType: Boolean UpdateType: Immutable .PARAMETER OwnershipControls + Amazon S3 Template Snippets: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-s3.html Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-ownershipcontrols Type: OwnershipControls UpdateType: Mutable .PARAMETER PublicAccessBlockConfiguration Configuration that defines how Amazon S3 handles public access. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration Type: PublicAccessBlockConfiguration UpdateType: Mutable .PARAMETER ReplicationConfiguration Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property. Amazon S3 can store replicated objects in only one destination bucket. The destination bucket must already exist and be in a different AWS Region than your source bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-replicationconfiguration Type: ReplicationConfiguration UpdateType: Mutable .PARAMETER Tags An arbitrary set of tags key-value pairs for this S3 bucket. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-tags DuplicatesAllowed: True ItemType: Tag Type: List UpdateType: Mutable .PARAMETER VersioningConfiguration Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-versioning Type: VersioningConfiguration UpdateType: Mutable .PARAMETER WebsiteConfiguration Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon S3: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-websiteconfiguration Type: WebsiteConfiguration UpdateType: Mutable .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([S3Bucket])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] $AccelerateConfiguration, [parameter(Mandatory = $false)] [object] $AccessControl, [parameter(Mandatory = $false)] [object] $AnalyticsConfigurations, [parameter(Mandatory = $false)] $BucketEncryption, [parameter(Mandatory = $false)] [object] $BucketName, [parameter(Mandatory = $false)] $CorsConfiguration, [parameter(Mandatory = $false)] [object] $IntelligentTieringConfigurations, [parameter(Mandatory = $false)] [object] $InventoryConfigurations, [parameter(Mandatory = $false)] $LifecycleConfiguration, [parameter(Mandatory = $false)] $LoggingConfiguration, [parameter(Mandatory = $false)] [object] $MetricsConfigurations, [parameter(Mandatory = $false)] $NotificationConfiguration, [parameter(Mandatory = $false)] $ObjectLockConfiguration, [parameter(Mandatory = $false)] [object] $ObjectLockEnabled, [parameter(Mandatory = $false)] $OwnershipControls, [parameter(Mandatory = $false)] $PublicAccessBlockConfiguration, [parameter(Mandatory = $false)] $ReplicationConfiguration, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter(Mandatory = $false)] $VersioningConfiguration, [parameter(Mandatory = $false)] $WebsiteConfiguration, [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 = [S3Bucket]::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-VSS3Bucket' function New-VSS3BucketPolicy { <# .SYNOPSIS Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. .DESCRIPTION Adds an AWS::S3::BucketPolicy resource to the template. Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. **Important** Only one bucket policy should be applied to a bucket. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. **Important** As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html. The following operations are related to PutBucketPolicy: + CreateBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + DeleteBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.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 Bucket The name of the Amazon S3 bucket to which the policy applies. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-bucket PrimitiveType: String UpdateType: Immutable .PARAMETER PolicyDocument A policy document containing permissions to add to the specified bucket. For more information, see Access Policy Language Overview: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html in the *Amazon Simple Storage Service Developer Guide*. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-policydocument PrimitiveType: Json UpdateType: Mutable .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([S3BucketPolicy])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] [object] $Bucket, [parameter(Mandatory = $true)] [VSJson] $PolicyDocument, [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 = [S3BucketPolicy]::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-VSS3BucketPolicy' function New-VSS3StorageLens { <# .SYNOPSIS Adds an AWS::S3::StorageLens resource to the template. .DESCRIPTION Adds an AWS::S3::StorageLens resource to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.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 StorageLensConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-storagelensconfiguration UpdateType: Mutable Type: StorageLensConfiguration .PARAMETER Tags Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-tags UpdateType: Mutable Type: List ItemType: Tag DuplicatesAllowed: False .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([S3StorageLens])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $true)] $StorageLensConfiguration, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [S3StorageLens]::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-VSS3StorageLens' |