Show / Hide Table of Contents

Class CfnBucketProps

Properties for defining a CfnBucket.

Inheritance
object
CfnBucketProps
Implements
ICfnBucketProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBucketProps : ICfnBucketProps
Syntax (vb)
Public Class CfnBucketProps Implements ICfnBucketProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnBucketProps = new CfnBucketProps {
                 BucketName = "bucketName",
                 BundleId = "bundleId",

                 // the properties below are optional
                 AccessRules = new AccessRulesProperty {
                     AllowPublicOverrides = false,
                     ObjectAccess = "objectAccess"
                 },
                 ObjectVersioning = false,
                 ReadOnlyAccessAccounts = new [] { "readOnlyAccessAccounts" },
                 ResourcesReceivingAccess = new [] { "resourcesReceivingAccess" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnBucketProps()

Properties for defining a CfnBucket.

Properties

AccessRules

An object that describes the access rules for the bucket.

BucketName

The name of the bucket.

BundleId

The bundle ID for the bucket (for example, small_1_0 ).

ObjectVersioning

Indicates whether object versioning is enabled for the bucket.

ReadOnlyAccessAccounts

An array of AWS account IDs that have read-only access to the bucket.

ResourcesReceivingAccess

An array of Lightsail instances that have access to the bucket.

Tags

An array of key-value pairs to apply to this resource.

Constructors

CfnBucketProps()

Properties for defining a CfnBucket.

public CfnBucketProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnBucketProps = new CfnBucketProps {
                 BucketName = "bucketName",
                 BundleId = "bundleId",

                 // the properties below are optional
                 AccessRules = new AccessRulesProperty {
                     AllowPublicOverrides = false,
                     ObjectAccess = "objectAccess"
                 },
                 ObjectVersioning = false,
                 ReadOnlyAccessAccounts = new [] { "readOnlyAccessAccounts" },
                 ResourcesReceivingAccess = new [] { "resourcesReceivingAccess" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AccessRules

An object that describes the access rules for the bucket.

public object? AccessRules { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-accessrules

BucketName

The name of the bucket.

public string BucketName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bucketname

BundleId

The bundle ID for the bucket (for example, small_1_0 ).

public string BundleId { get; set; }
Property Value

string

Remarks

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bundleid

ObjectVersioning

Indicates whether object versioning is enabled for the bucket.

public object? ObjectVersioning { get; set; }
Property Value

object

Remarks

The following options can be configured:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-objectversioning

    ReadOnlyAccessAccounts

    An array of AWS account IDs that have read-only access to the bucket.

    public string[]? ReadOnlyAccessAccounts { get; set; }
    Property Value

    string[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-readonlyaccessaccounts

    ResourcesReceivingAccess

    An array of Lightsail instances that have access to the bucket.

    public string[]? ResourcesReceivingAccess { get; set; }
    Property Value

    string[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-resourcesreceivingaccess

    Tags

    An array of key-value pairs to apply to this resource.

    public ICfnTag[]? Tags { get; set; }
    Property Value

    ICfnTag[]

    Remarks

    For more information, see Tag in the AWS CloudFormation User Guide .

    The <code>Value</code> of <code>Tags</code> is optional for Lightsail resources.
    

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-tags

    Implements

    ICfnBucketProps
    Back to top Generated by DocFX