Skip to content

Bucket

This class encapsulates and extends the ROS resource type ALIYUN::OSS::Bucket.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkoss"
alicloudroscdkoss.NewBucket(scope Construct, id *string, props BucketProps, enableResourcePropertyConstraint *bool) Bucket
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props BucketProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

idRequired

  • Type: *string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: *bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
AddCondition No description.
AddCount No description.
AddDependency No description.
AddResourceDesc No description.
ApplyRemovalPolicy No description.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc No description.
GetAtt No description.
SetMetadata No description.
ArnForObjects Returns an ARN that represents all objects within the bucket that match the key pattern specified.
GrantFullAccess Grant an RAM principal (Role/Group/User) full control over this bucket.
GrantList Grant an RAM principal (Role/Group/User) permission to list resources for this bucket.
GrantRead Grant an RAM principal (Role/Group/User) permission to list and read all resources for this bucket.
GrantReadWrite Grant an RAM principal (Role/Group/User) permission to read and write resources for this bucket.

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


AddCondition

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

ArnForObjects

func ArnForObjects(keyPattern *string) *string

Returns an ARN that represents all objects within the bucket that match the key pattern specified.

To represent all keys, specify "*".

If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:

arnForObjects(home/${team}/${user}/*)

keyPatternRequired

  • Type: *string

GrantFullAccess

func GrantFullAccess(identity IPrincipal, objectsKeyPattern *string) ManagedPolicy

Grant an RAM principal (Role/Group/User) full control over this bucket.

identityRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkram.IPrincipal

The principal.


objectsKeyPatternOptional

  • Type: *string

Restrict the permission to a certain key pattern (default '*').


GrantList

func GrantList(identity IPrincipal, objectsKeyPattern *string) ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to list resources for this bucket.

identityRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkram.IPrincipal

The principal.


objectsKeyPatternOptional

  • Type: *string

Restrict the permission to a certain key pattern (default '*').


GrantRead

func GrantRead(identity IPrincipal, objectsKeyPattern *string) ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to list and read all resources for this bucket.

identityRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkram.IPrincipal

The principal.


objectsKeyPatternOptional

  • Type: *string

Restrict the permission to a certain key pattern (default '*').


GrantReadWrite

func GrantReadWrite(identity IPrincipal, objectsKeyPattern *string) ManagedPolicy

Grant an RAM principal (Role/Group/User) permission to read and write resources for this bucket.

identityRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkram.IPrincipal

The principal.


objectsKeyPatternOptional

  • Type: *string

Restrict the permission to a certain key pattern (default '*').


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
ValidateBucketName Thrown an exception if the given bucket name is not valid.

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkoss"
alicloudroscdkoss.Bucket_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

ValidateBucketName

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkoss"
alicloudroscdkoss.Bucket_ValidateBucketName(physicalName *string)

Thrown an exception if the given bucket name is not valid.

physicalNameRequired

  • Type: *string

name of the bucket.


Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Env github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment The environment this resource belongs to.
Ref *string No description.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this resource is defined.
Resource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource No description.
AttrArn interface{} Attribute Arn: The Alibaba Cloud Resource Name (ARN).
AttrDomainName interface{} Attribute DomainName: The public DNS name of the specified bucket.
AttrInternalDomainName interface{} Attribute InternalDomainName: The internal DNS name of the specified bucket.
AttrName interface{} Attribute Name: The name of Bucket.
Props BucketProps No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


EnvRequired

func Env() IResourceEnvironment
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


RefRequired

func Ref() *string
  • Type: *string

StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.


ResourceOptional

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrArnRequired

func AttrArn() interface{}
  • Type: interface{}

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


AttrDomainNameRequired

func AttrDomainName() interface{}
  • Type: interface{}

Attribute DomainName: The public DNS name of the specified bucket.


AttrInternalDomainNameRequired

func AttrInternalDomainName() interface{}
  • Type: interface{}

Attribute InternalDomainName: The internal DNS name of the specified bucket.


AttrNameRequired

func AttrName() interface{}
  • Type: interface{}

Attribute Name: The name of Bucket.


PropsRequired

func Props() BucketProps