Class CfnBucket

The AWS::Lightsail::Bucket resource specifies a bucket.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnBucket

Implements

IInspectable

IBucketRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Lightsail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBucket : CfnResource, IInspectable, IBucketRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnBucket Inherits CfnResource Implements IInspectable, IBucketRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

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 cfnBucket = new CfnBucket(this, "MyCfnBucket", 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

CfnBucket(Construct, string, ICfnBucketProps)

Create a new AWS::Lightsail::Bucket.

Properties

AccessRules	An object that describes the access rules for the bucket.
AttrAbleToUpdateBundle	A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.
AttrBucketArn	The Amazon Resource Name (ARN) of the bucket.
AttrUrl	The URL of the bucket.
BucketName	The name of the bucket.
BucketRef	A reference to a Bucket resource.
BundleId	The bundle ID for the bucket (for example, `small_1_0` ).
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::Lightsail::Bucket` resource specifies a bucket.
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	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.

Methods

ArnForBucket(IBucketRef)	The `AWS::Lightsail::Bucket` resource specifies a bucket.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnBucket(object)	Checks whether the given object is a CfnBucket.
RenderProperties(IDictionary<string, object>)	The `AWS::Lightsail::Bucket` resource specifies a bucket.

Constructors

CfnBucket(Construct, string, ICfnBucketProps)

Create a new AWS::Lightsail::Bucket.

public CfnBucket(Construct scope, string id, ICfnBucketProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnBucketProps: Resource properties.

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

Properties

AccessRules

An object that describes the access rules for the bucket.

public virtual object? AccessRules { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnBucket.IAccessRulesProperty

AttrAbleToUpdateBundle

A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.

public virtual IResolvable AttrAbleToUpdateBundle { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: AbleToUpdateBundle

AttrBucketArn

The Amazon Resource Name (ARN) of the bucket.

public virtual string AttrBucketArn { get; }

Property Value

string

Remarks

CloudformationAttribute: BucketArn

AttrUrl

The URL of the bucket.

public virtual string AttrUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: Url

BucketName

The name of the bucket.

public virtual string BucketName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

BucketRef

A reference to a Bucket resource.

public virtual IBucketReference BucketRef { get; }

Property Value

IBucketReference

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

BundleId

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

public virtual string BundleId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Lightsail::Bucket resource specifies a bucket.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

ObjectVersioning

Indicates whether object versioning is enabled for the bucket.

public virtual object? ObjectVersioning { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

ReadOnlyAccessAccounts

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

public virtual string[]? ReadOnlyAccessAccounts { get; set; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

ResourcesReceivingAccess

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

public virtual string[]? ResourcesReceivingAccess { get; set; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

Methods

ArnForBucket(IBucketRef)

The AWS::Lightsail::Bucket resource specifies a bucket.

public static string ArnForBucket(IBucketRef resource)

Parameters

resource IBucketRef

Returns

string

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

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 cfnBucket = new CfnBucket(this, "MyCfnBucket", 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"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

IsCfnBucket(object)

Checks whether the given object is a CfnBucket.

public static bool IsCfnBucket(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Lightsail::Bucket resource specifies a bucket.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::Lightsail::Bucket

ExampleMetadata: fixture=_generated

Implements

IInspectable

IBucketRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable