< Back

Add-CfnS3_BucketResource

Sat Jan 11, 2020 7:46 am

NAME Add-CfnS3_BucketResource



SYNOPSIS

The AWS::S3::Bucket type creates an Amazon S3 bucket.





SYNTAX

Add-CfnS3_BucketResource [-ResourceName] <String> [-AccessControl <String>] [-BucketName <String>]

[-CorsConfiguration <IDictionary>] [-LifecycleConfiguration <IDictionary>] [-LoggingConfiguration <IDictionary>]

[-NotificationConfiguration <IDictionary>] [-ReplicationConfiguration <IDictionary>] [-Tags <IDictionary>]

[-VersioningConfiguration <IDictionary>] [-WebsiteConfiguration <IDictionary>] [-DeletionPolicy <String>]

[-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>]

[<CommonParameters>]





DESCRIPTION





PARAMETERS

-ResourceName <String>



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AccessControl <String>

A canned ACL that grants predefined permissions on the bucket. Default is Private.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BucketName <String>

A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses

that ID for the bucket name.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CorsConfiguration <IDictionary>

Rules that define cross-origin resource sharing of objects in this bucket.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LifecycleConfiguration <IDictionary>

Rules that define how Amazon S3 manages objects during their lifetime.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LoggingConfiguration <IDictionary>

Settings that defines where logs are stored.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NotificationConfiguration <IDictionary>

Configuration that defines which Amazon SNS topic to send messages to and what events to report.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReplicationConfiguration <IDictionary>

Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning

by using the VersioningConfiguration property.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tags <IDictionary>

The tags that you want to attach.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-VersioningConfiguration <IDictionary>

Enables multiple variants 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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WebsiteConfiguration <IDictionary>

Information used to configure the bucket as a static website.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DeletionPolicy <String>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Metadata <Hashtable>

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 format 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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DependsOn <Array>

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. You can use the DependsOn attribute with any resource.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PropertiesBlock <ScriptBlock>

Allows you to declare a block of one or more Property statements.



A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,

and specify Property assignments that may include CloudFormation function calls or references, or computed

values.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Condition <Object>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

http://docs.aws.amazon.com/AWSCloudForm ... olicy.html

http://docs.aws.amazon.com/AWSCloudForm ... adata.html

http://docs.aws.amazon.com/AWSCloudForm ... ndson.html

http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html

http://docs.aws.amazon.com/search/doc-s ... S3::Bucket