Class CfnBucket
A CloudFormation AWS::Lightsail::Bucket
.
Inherited Members
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public class CfnBucket : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBucket
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Lightsail::Bucket
resource specifies a bucket.
CloudformationResource: AWS::Lightsail::Bucket
Link: 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 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 |
CfnBucket(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBucket(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
BundleId | The bundle ID for the bucket (for example, |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnBucketProps
- resource properties.
CfnBucket(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBucket(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBucket(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBucket(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessRules
An object that describes the access rules for the bucket.
public virtual object AccessRules { get; set; }
Property Value
System.Object
Remarks
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
Remarks
CloudformationAttribute: AbleToUpdateBundle
AttrBucketArn
The Amazon Resource Name (ARN) of the bucket.
public virtual string AttrBucketArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: BucketArn
AttrUrl
The URL of the bucket.
public virtual string AttrUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Url
BucketName
The name of the bucket.
public virtual string BucketName { get; set; }
Property Value
System.String
Remarks
BundleId
The bundle ID for the bucket (for example, small_1_0
).
public virtual string BundleId { get; set; }
Property Value
System.String
Remarks
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ObjectVersioning
Indicates whether object versioning is enabled for the bucket.
public virtual object ObjectVersioning { get; set; }
Property Value
System.Object
Remarks
The following options can be configured:
ReadOnlyAccessAccounts
An array of AWS account IDs that have read-only access to the bucket.
public virtual string[] ReadOnlyAccessAccounts { get; set; }
Property Value
System.String[]
Remarks
ResourcesReceivingAccess
An array of Lightsail instances that have access to the bucket.
public virtual string[] ResourcesReceivingAccess { get; set; }
Property Value
System.String[]
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag in the AWS CloudFormation User Guide .
The Value
of Tags
is optional for Lightsail resources.
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>