Add-VSS3BucketDefaultRetention
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.
SYNTAX
Add-VSS3BucketDefaultRetention [[-Days] <Object>] [[-Mode] <Object>] [[-Years] <Object>] [<CommonParameters>]
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.
PARAMETERS
-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
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.