alicloudroscdkoss

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 25, 2025 License: Apache-2.0 Imports: 7 Imported by: 2

README

Aliyun ROS OSS Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as OSS from '@alicloud/ros-cdk-oss';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bucket_IsConstruct 

func Bucket_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Bucket_ValidateBucketName 

func Bucket_ValidateBucketName(physicalName *string)

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

func Directory_IsConstruct 

func Directory_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Domain_IsConstruct 

func Domain_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewBucket_Override 

func NewBucket_Override(b Bucket, scope alicloudroscdkcore.Construct, id *string, props *BucketProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDirectory_Override 

func NewDirectory_Override(d Directory, scope alicloudroscdkcore.Construct, id *string, props *DirectoryProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDomain_Override 

func NewDomain_Override(d Domain, scope alicloudroscdkcore.Construct, id *string, props *DomainProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewObjectAcl_Override 

func NewObjectAcl_Override(o ObjectAcl, scope alicloudroscdkcore.Construct, id *string, props *ObjectAclProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosBucket_Override 

func NewRosBucket_Override(r RosBucket, scope alicloudroscdkcore.Construct, id *string, props *RosBucketProps, enableResourcePropertyConstraint *bool)

func NewRosDirectory_Override 

func NewRosDirectory_Override(r RosDirectory, scope alicloudroscdkcore.Construct, id *string, props *RosDirectoryProps, enableResourcePropertyConstraint *bool)

func NewRosDomain_Override 

func NewRosDomain_Override(r RosDomain, scope alicloudroscdkcore.Construct, id *string, props *RosDomainProps, enableResourcePropertyConstraint *bool)

func NewRosObjectAcl_Override 

func NewRosObjectAcl_Override(r RosObjectAcl, scope alicloudroscdkcore.Construct, id *string, props *RosObjectAclProps, enableResourcePropertyConstraint *bool)

func NewRosWebsite_Override 

func NewRosWebsite_Override(r RosWebsite, scope alicloudroscdkcore.Construct, id *string, props *RosWebsiteProps, enableResourcePropertyConstraint *bool)

func NewWebsite_Override 

func NewWebsite_Override(w Website, scope alicloudroscdkcore.Construct, id *string, props *WebsiteProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func ObjectAcl_IsConstruct 

func ObjectAcl_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosBucket_IsConstruct 

func RosBucket_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosBucket_IsRosElement 

func RosBucket_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosBucket_IsRosResource 

func RosBucket_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosBucket_ROS_RESOURCE_TYPE_NAME 

func RosBucket_ROS_RESOURCE_TYPE_NAME() *string

func RosDirectory_IsConstruct 

func RosDirectory_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDirectory_IsRosElement 

func RosDirectory_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDirectory_IsRosResource 

func RosDirectory_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDirectory_ROS_RESOURCE_TYPE_NAME 

func RosDirectory_ROS_RESOURCE_TYPE_NAME() *string

func RosDomain_IsConstruct 

func RosDomain_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDomain_IsRosElement 

func RosDomain_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDomain_IsRosResource 

func RosDomain_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDomain_ROS_RESOURCE_TYPE_NAME 

func RosDomain_ROS_RESOURCE_TYPE_NAME() *string

func RosObjectAcl_IsConstruct 

func RosObjectAcl_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosObjectAcl_IsRosElement 

func RosObjectAcl_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosObjectAcl_IsRosResource 

func RosObjectAcl_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosObjectAcl_ROS_RESOURCE_TYPE_NAME 

func RosObjectAcl_ROS_RESOURCE_TYPE_NAME() *string

func RosWebsite_IsConstruct 

func RosWebsite_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosWebsite_IsRosElement 

func RosWebsite_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosWebsite_IsRosResource 

func RosWebsite_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosWebsite_ROS_RESOURCE_TYPE_NAME 

func RosWebsite_ROS_RESOURCE_TYPE_NAME() *string

func Website_IsConstruct 

func Website_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type Bucket 

type Bucket interface {
	alicloudroscdkcore.Resource
	IBucket
	// Attribute DomainName: The public DNS name of the specified bucket.
	AttrDomainName() interface{}
	// Attribute InternalDomainName: The internal DNS name of the specified bucket.
	AttrInternalDomainName() interface{}
	// Attribute Name: The name of Bucket.
	AttrName() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *BucketProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::OSS::Bucket`, which is used to create a bucket in Object Storage Service (OSS).

func NewBucket 

func NewBucket(scope alicloudroscdkcore.Construct, id *string, props *BucketProps, enableResourcePropertyConstraint *bool) Bucket

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type BucketAttributes 

type BucketAttributes struct {
	// The domain name of the bucket.
	BucketDomainName *string `field:"optional" json:"bucketDomainName" yaml:"bucketDomainName"`
	// The endpoint of the bucket.
	BucketEndpoint *string `field:"optional" json:"bucketEndpoint" yaml:"bucketEndpoint"`
	// The name of the bucket.
	BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"`
	// The website URL of the bucket (if static web hosting is enabled).
	BucketWebsiteUrl *string `field:"optional" json:"bucketWebsiteUrl" yaml:"bucketWebsiteUrl"`
	// If this bucket has been configured for static website hosting.
	IsWebsite *bool `field:"optional" json:"isWebsite" yaml:"isWebsite"`
	// The region this existing bucket is in.
	//
	// Features that require the region (e.g. `bucketWebsiteUrl`) won't fully work
	// if the region cannot be correctly inferred.
	Region *string `field:"optional" json:"region" yaml:"region"`
}

A reference to a bucket outside this stack.

type BucketProps 

type BucketProps struct {
	// Property bucketName: bucket name.
	BucketName interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	// Property accessControl: The access control list.
	AccessControl interface{} `field:"optional" json:"accessControl" yaml:"accessControl"`
	// Property corsConfiguration: Rules that define cross-origin resource sharing of objects in this bucket.
	CorsConfiguration interface{} `field:"optional" json:"corsConfiguration" yaml:"corsConfiguration"`
	// Property deletionForce: Whether force delete the relative objects in the bucket.
	//
	// Default value is false.
	DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"`
	// Property enableOssHdfsService: Whether enable OSS-HDFS service.
	//
	// **Note**: Once it's enabled, it can't be disabled again.
	EnableOssHdfsService interface{} `field:"optional" json:"enableOssHdfsService" yaml:"enableOssHdfsService"`
	// Property lifecycleConfiguration: Rules that define how oss bucket manages objects during their lifetime.
	LifecycleConfiguration interface{} `field:"optional" json:"lifecycleConfiguration" yaml:"lifecycleConfiguration"`
	// Property loggingConfiguration: Settings that defines where logs are stored.
	LoggingConfiguration interface{} `field:"optional" json:"loggingConfiguration" yaml:"loggingConfiguration"`
	// Property policy: Bucket policy.
	Policy interface{} `field:"optional" json:"policy" yaml:"policy"`
	// Property redundancyType: Specifies the data disaster recovery type of the storage space.
	//
	// The value range is as follows:
	// LRS (default): Local redundant LRS stores your data redundantly on different storage devices in the same availability zone, and can support data loss and normal access even when two storage devices are damaged concurrently.
	// ZRS: Intra-city redundant ZRS adopts a data redundancy storage mechanism in multiple availability zones (AZ), and stores user data redundantly in multiple availability zones in the same region. When an availability zone is unavailable, normal access to data can still be guaranteed.
	RedundancyType interface{} `field:"optional" json:"redundancyType" yaml:"redundancyType"`
	// Property refererConfiguration: undefined.
	RefererConfiguration interface{} `field:"optional" json:"refererConfiguration" yaml:"refererConfiguration"`
	// Property resourceGroupId: The resource group id.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	// Property serverSideEncryptionConfiguration: Specifies the bucket used to store the server-side encryption rule.
	ServerSideEncryptionConfiguration interface{} `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
	// Property storageClass: Specifies the storage class of the bucket.
	//
	// Default is "Standard".
	StorageClass interface{} `field:"optional" json:"storageClass" yaml:"storageClass"`
	// Property tags: Bucket tags in k-v pairs format.
	Tags *map[string]interface{} `field:"optional" json:"tags" yaml:"tags"`
	// Property versioningConfiguration: A state of versioning.
	VersioningConfiguration interface{} `field:"optional" json:"versioningConfiguration" yaml:"versioningConfiguration"`
	// Property websiteConfigurationV2: Website configuration.
	WebsiteConfigurationV2 interface{} `field:"optional" json:"websiteConfigurationV2" yaml:"websiteConfigurationV2"`
}

Properties for defining a `Bucket`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-bucket

type Directory 

type Directory interface {
	alicloudroscdkcore.Resource
	IDirectory
	// Attribute BucketName: The name of Bucket.
	AttrBucketName() interface{}
	// Attribute DirectoryName: The name of Directory.
	AttrDirectoryName() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DirectoryProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::OSS::Directory`, which is used to create a directory for a specified bucket.

func NewDirectory 

func NewDirectory(scope alicloudroscdkcore.Construct, id *string, props *DirectoryProps, enableResourcePropertyConstraint *bool) Directory

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DirectoryProps 

type DirectoryProps struct {
	// Property bucketName: bucket name.
	BucketName interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	// Property directoryName: Directory name.
	DirectoryName interface{} `field:"required" json:"directoryName" yaml:"directoryName"`
	// Property deletionForce: Whether force delete the relative objects in the directory.
	//
	// Default value is false.
	DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"`
}

Properties for defining a `Directory`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-directory

type Domain 

type Domain interface {
	alicloudroscdkcore.Resource
	IDomain
	// Attribute BucketName: The name of Bucket.
	AttrBucketName() interface{}
	// Attribute DomainName: The custom domain name.
	AttrDomainName() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DomainProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::OSS::Domain`, which is used to bind a custom domain name.

func NewDomain 

func NewDomain(scope alicloudroscdkcore.Construct, id *string, props *DomainProps, enableResourcePropertyConstraint *bool) Domain

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DomainProps 

type DomainProps struct {
	// Property bucketName: bucket name.
	BucketName interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	// Property domainName: Domain name.
	DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"`
}

Properties for defining a `Domain`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-domain

type IBucket added in v1.6.0 

type IBucket interface {
	alicloudroscdkcore.IResource
	// Attribute DomainName: The public DNS name of the specified bucket.
	AttrDomainName() interface{}
	// Attribute InternalDomainName: The internal DNS name of the specified bucket.
	AttrInternalDomainName() interface{}
	// Attribute Name: The name of Bucket.
	AttrName() interface{}
	Props() *BucketProps
}

Represents a `Bucket`.

type IDirectory added in v1.6.0 

type IDirectory interface {
	alicloudroscdkcore.IResource
	// Attribute BucketName: The name of Bucket.
	AttrBucketName() interface{}
	// Attribute DirectoryName: The name of Directory.
	AttrDirectoryName() interface{}
	Props() *DirectoryProps
}

Represents a `Directory`.

type IDomain added in v1.6.0 

type IDomain interface {
	alicloudroscdkcore.IResource
	// Attribute BucketName: The name of Bucket.
	AttrBucketName() interface{}
	// Attribute DomainName: The custom domain name.
	AttrDomainName() interface{}
	Props() *DomainProps
}

Represents a `Domain`.

type IObjectAcl added in v1.6.0 

type IObjectAcl interface {
	alicloudroscdkcore.IResource
	Props() *ObjectAclProps
}

Represents a `ObjectAcl`.

type IWebsite added in v1.6.0 

type IWebsite interface {
	alicloudroscdkcore.IResource
	Props() *WebsiteProps
}

Represents a `Website`.

type ObjectAcl 

type ObjectAcl interface {
	alicloudroscdkcore.Resource
	IObjectAcl
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *ObjectAclProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::OSS::ObjectAcl`, which is used to modify the access control list (ACL) of an Object Storage Service (OSS) object.

func NewObjectAcl 

func NewObjectAcl(scope alicloudroscdkcore.Construct, id *string, props *ObjectAclProps, enableResourcePropertyConstraint *bool) ObjectAcl

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type ObjectAclProps 

type ObjectAclProps struct {
	// Property bucket: Bucket name.
	Bucket interface{} `field:"required" json:"bucket" yaml:"bucket"`
	// Property objectAcl: Object acl.
	ObjectAcl interface{} `field:"required" json:"objectAcl" yaml:"objectAcl"`
	// Property objectKey: Object key.
	ObjectKey interface{} `field:"required" json:"objectKey" yaml:"objectKey"`
}

Properties for defining a `ObjectAcl`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-objectacl

type RosBucket 

type RosBucket interface {
	alicloudroscdkcore.RosResource
	AccessControl() interface{}
	SetAccessControl(val interface{})
	AttrDomainName() alicloudroscdkcore.IResolvable
	AttrInternalDomainName() alicloudroscdkcore.IResolvable
	AttrName() alicloudroscdkcore.IResolvable
	BucketName() interface{}
	SetBucketName(val interface{})
	CorsConfiguration() interface{}
	SetCorsConfiguration(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DeletionForce() interface{}
	SetDeletionForce(val interface{})
	EnableOssHdfsService() interface{}
	SetEnableOssHdfsService(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	LifecycleConfiguration() interface{}
	SetLifecycleConfiguration(val interface{})
	LoggingConfiguration() interface{}
	SetLoggingConfiguration(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	Policy() interface{}
	SetPolicy(val interface{})
	RedundancyType() interface{}
	SetRedundancyType(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	RefererConfiguration() interface{}
	SetRefererConfiguration(val interface{})
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	ServerSideEncryptionConfiguration() interface{}
	SetServerSideEncryptionConfiguration(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	StorageClass() interface{}
	SetStorageClass(val interface{})
	Tags() *map[string]interface{}
	SetTags(val *map[string]interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VersioningConfiguration() interface{}
	SetVersioningConfiguration(val interface{})
	WebsiteConfigurationV2() interface{}
	SetWebsiteConfigurationV2(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::OSS::Bucket`, which is used to create a bucket in Object Storage Service (OSS).

func NewRosBucket 

func NewRosBucket(scope alicloudroscdkcore.Construct, id *string, props *RosBucketProps, enableResourcePropertyConstraint *bool) RosBucket

type RosBucketProps 

type RosBucketProps struct {
	BucketName                        interface{}             `field:"required" json:"bucketName" yaml:"bucketName"`
	AccessControl                     interface{}             `field:"optional" json:"accessControl" yaml:"accessControl"`
	CorsConfiguration                 interface{}             `field:"optional" json:"corsConfiguration" yaml:"corsConfiguration"`
	DeletionForce                     interface{}             `field:"optional" json:"deletionForce" yaml:"deletionForce"`
	EnableOssHdfsService              interface{}             `field:"optional" json:"enableOssHdfsService" yaml:"enableOssHdfsService"`
	LifecycleConfiguration            interface{}             `field:"optional" json:"lifecycleConfiguration" yaml:"lifecycleConfiguration"`
	LoggingConfiguration              interface{}             `field:"optional" json:"loggingConfiguration" yaml:"loggingConfiguration"`
	Policy                            interface{}             `field:"optional" json:"policy" yaml:"policy"`
	RedundancyType                    interface{}             `field:"optional" json:"redundancyType" yaml:"redundancyType"`
	RefererConfiguration              interface{}             `field:"optional" json:"refererConfiguration" yaml:"refererConfiguration"`
	ResourceGroupId                   interface{}             `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	ServerSideEncryptionConfiguration interface{}             `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
	StorageClass                      interface{}             `field:"optional" json:"storageClass" yaml:"storageClass"`
	Tags                              *map[string]interface{} `field:"optional" json:"tags" yaml:"tags"`
	VersioningConfiguration           interface{}             `field:"optional" json:"versioningConfiguration" yaml:"versioningConfiguration"`
	WebsiteConfigurationV2            interface{}             `field:"optional" json:"websiteConfigurationV2" yaml:"websiteConfigurationV2"`
}

Properties for defining a `RosBucket`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-bucket

type RosBucket_AbortMultipartUploadProperty 

type RosBucket_AbortMultipartUploadProperty struct {
	CreatedBeforeDate interface{} `field:"optional" json:"createdBeforeDate" yaml:"createdBeforeDate"`
	Days              interface{} `field:"optional" json:"days" yaml:"days"`
}

type RosBucket_CORSConfigurationProperty 

type RosBucket_CORSConfigurationProperty struct {
	CorsRule     interface{} `field:"optional" json:"corsRule" yaml:"corsRule"`
	ResponseVary interface{} `field:"optional" json:"responseVary" yaml:"responseVary"`
}

type RosBucket_CORSRuleProperty 

type RosBucket_CORSRuleProperty struct {
	AllowedHeader interface{} `field:"optional" json:"allowedHeader" yaml:"allowedHeader"`
	AllowedMethod interface{} `field:"optional" json:"allowedMethod" yaml:"allowedMethod"`
	AllowedOrigin interface{} `field:"optional" json:"allowedOrigin" yaml:"allowedOrigin"`
	ExposeHeader  interface{} `field:"optional" json:"exposeHeader" yaml:"exposeHeader"`
	MaxAgeSeconds interface{} `field:"optional" json:"maxAgeSeconds" yaml:"maxAgeSeconds"`
}

type RosBucket_ConditionProperty 

type RosBucket_ConditionProperty struct {
	HttpErrorCodeReturnedEquals interface{} `field:"optional" json:"httpErrorCodeReturnedEquals" yaml:"httpErrorCodeReturnedEquals"`
	IncludeHeaders              interface{} `field:"optional" json:"includeHeaders" yaml:"includeHeaders"`
	KeyPrefixEquals             interface{} `field:"optional" json:"keyPrefixEquals" yaml:"keyPrefixEquals"`
	KeySuffixEquals             interface{} `field:"optional" json:"keySuffixEquals" yaml:"keySuffixEquals"`
}

type RosBucket_ErrorDocumentProperty 

type RosBucket_ErrorDocumentProperty struct {
	Key        interface{} `field:"required" json:"key" yaml:"key"`
	HttpStatus interface{} `field:"optional" json:"httpStatus" yaml:"httpStatus"`
}

type RosBucket_ExpirationProperty 

type RosBucket_ExpirationProperty struct {
	CreatedBeforeDate         interface{} `field:"optional" json:"createdBeforeDate" yaml:"createdBeforeDate"`
	Days                      interface{} `field:"optional" json:"days" yaml:"days"`
	ExpiredObjectDeleteMarker interface{} `field:"optional" json:"expiredObjectDeleteMarker" yaml:"expiredObjectDeleteMarker"`
}

type RosBucket_FilterProperty 

type RosBucket_FilterProperty struct {
	Not interface{} `field:"optional" json:"not" yaml:"not"`
}

type RosBucket_IncludeHeadersProperty 

type RosBucket_IncludeHeadersProperty struct {
	Key      interface{} `field:"required" json:"key" yaml:"key"`
	EqualsTo interface{} `field:"optional" json:"equalsTo" yaml:"equalsTo"`
}

type RosBucket_IndexDocumentProperty 

type RosBucket_IndexDocumentProperty struct {
	Suffix        interface{} `field:"required" json:"suffix" yaml:"suffix"`
	SupportSubDir interface{} `field:"optional" json:"supportSubDir" yaml:"supportSubDir"`
	Type          interface{} `field:"optional" json:"type" yaml:"type"`
}

type RosBucket_LifecycleConfigurationProperty 

type RosBucket_LifecycleConfigurationProperty struct {
	Rule interface{} `field:"required" json:"rule" yaml:"rule"`
}

type RosBucket_LoggingConfigurationProperty 

type RosBucket_LoggingConfigurationProperty struct {
	TargetBucket interface{} `field:"optional" json:"targetBucket" yaml:"targetBucket"`
	TargetPrefix interface{} `field:"optional" json:"targetPrefix" yaml:"targetPrefix"`
}

type RosBucket_MirrorHeadersProperty 

type RosBucket_MirrorHeadersProperty struct {
	Pass    interface{} `field:"optional" json:"pass" yaml:"pass"`
	PassAll interface{} `field:"optional" json:"passAll" yaml:"passAll"`
	Remove  interface{} `field:"optional" json:"remove" yaml:"remove"`
	Sets    interface{} `field:"optional" json:"sets" yaml:"sets"`
}

type RosBucket_NotProperty 

type RosBucket_NotProperty struct {
	Prefix interface{} `field:"optional" json:"prefix" yaml:"prefix"`
	Tag    interface{} `field:"optional" json:"tag" yaml:"tag"`
}

type RosBucket_RedirectProperty 

type RosBucket_RedirectProperty struct {
	RedirectType          interface{} `field:"required" json:"redirectType" yaml:"redirectType"`
	EnableReplacePrefix   interface{} `field:"optional" json:"enableReplacePrefix" yaml:"enableReplacePrefix"`
	HostName              interface{} `field:"optional" json:"hostName" yaml:"hostName"`
	HttpRedirectCode      interface{} `field:"optional" json:"httpRedirectCode" yaml:"httpRedirectCode"`
	MirrorCheckMd5        interface{} `field:"optional" json:"mirrorCheckMd5" yaml:"mirrorCheckMd5"`
	MirrorFollowRedirect  interface{} `field:"optional" json:"mirrorFollowRedirect" yaml:"mirrorFollowRedirect"`
	MirrorHeaders         interface{} `field:"optional" json:"mirrorHeaders" yaml:"mirrorHeaders"`
	MirrorPassQueryString interface{} `field:"optional" json:"mirrorPassQueryString" yaml:"mirrorPassQueryString"`
	MirrorUrl             interface{} `field:"optional" json:"mirrorUrl" yaml:"mirrorUrl"`
	PassQueryString       interface{} `field:"optional" json:"passQueryString" yaml:"passQueryString"`
	Protocol              interface{} `field:"optional" json:"protocol" yaml:"protocol"`
	ReplaceKeyPrefixWith  interface{} `field:"optional" json:"replaceKeyPrefixWith" yaml:"replaceKeyPrefixWith"`
	ReplaceKeyWith        interface{} `field:"optional" json:"replaceKeyWith" yaml:"replaceKeyWith"`
}

type RosBucket_RefererConfigurationProperty 

type RosBucket_RefererConfigurationProperty struct {
	AllowEmptyReferer interface{} `field:"optional" json:"allowEmptyReferer" yaml:"allowEmptyReferer"`
	RefererList       interface{} `field:"optional" json:"refererList" yaml:"refererList"`
}

type RosBucket_RoutingRulesProperty 

type RosBucket_RoutingRulesProperty struct {
	Condition  interface{} `field:"required" json:"condition" yaml:"condition"`
	Redirect   interface{} `field:"required" json:"redirect" yaml:"redirect"`
	RuleNumber interface{} `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
}

type RosBucket_RuleProperty 

type RosBucket_RuleProperty struct {
	Prefix               interface{} `field:"required" json:"prefix" yaml:"prefix"`
	AbortMultipartUpload interface{} `field:"optional" json:"abortMultipartUpload" yaml:"abortMultipartUpload"`
	Expiration           interface{} `field:"optional" json:"expiration" yaml:"expiration"`
	Filter               interface{} `field:"optional" json:"filter" yaml:"filter"`
	Id                   interface{} `field:"optional" json:"id" yaml:"id"`
	Status               interface{} `field:"optional" json:"status" yaml:"status"`
}

type RosBucket_ServerSideEncryptionConfigurationProperty 

type RosBucket_ServerSideEncryptionConfigurationProperty struct {
	SseAlgorithm   interface{} `field:"required" json:"sseAlgorithm" yaml:"sseAlgorithm"`
	KmsMasterKeyId interface{} `field:"optional" json:"kmsMasterKeyId" yaml:"kmsMasterKeyId"`
}

type RosBucket_SetsProperty 

type RosBucket_SetsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"required" json:"value" yaml:"value"`
}

type RosBucket_VersioningConfigurationProperty 

type RosBucket_VersioningConfigurationProperty struct {
	Status interface{} `field:"required" json:"status" yaml:"status"`
}

type RosBucket_WebsiteConfigurationV2Property 

type RosBucket_WebsiteConfigurationV2Property struct {
	ErrorDocument interface{} `field:"optional" json:"errorDocument" yaml:"errorDocument"`
	IndexDocument interface{} `field:"optional" json:"indexDocument" yaml:"indexDocument"`
	RoutingRules  interface{} `field:"optional" json:"routingRules" yaml:"routingRules"`
}

type RosDirectory 

type RosDirectory interface {
	alicloudroscdkcore.RosResource
	AttrBucketName() alicloudroscdkcore.IResolvable
	AttrDirectoryName() alicloudroscdkcore.IResolvable
	BucketName() interface{}
	SetBucketName(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DeletionForce() interface{}
	SetDeletionForce(val interface{})
	DirectoryName() interface{}
	SetDirectoryName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::OSS::Directory`, which is used to create a directory for a specified bucket.

func NewRosDirectory 

func NewRosDirectory(scope alicloudroscdkcore.Construct, id *string, props *RosDirectoryProps, enableResourcePropertyConstraint *bool) RosDirectory

type RosDirectoryProps 

type RosDirectoryProps struct {
	BucketName    interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	DirectoryName interface{} `field:"required" json:"directoryName" yaml:"directoryName"`
	DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"`
}

Properties for defining a `RosDirectory`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-directory

type RosDomain 

type RosDomain interface {
	alicloudroscdkcore.RosResource
	AttrBucketName() alicloudroscdkcore.IResolvable
	AttrDomainName() alicloudroscdkcore.IResolvable
	BucketName() interface{}
	SetBucketName(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DomainName() interface{}
	SetDomainName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::OSS::Domain`, which is used to bind a custom domain name.

func NewRosDomain 

func NewRosDomain(scope alicloudroscdkcore.Construct, id *string, props *RosDomainProps, enableResourcePropertyConstraint *bool) RosDomain

type RosDomainProps 

type RosDomainProps struct {
	BucketName interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"`
}

Properties for defining a `RosDomain`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-domain

type RosObjectAcl 

type RosObjectAcl interface {
	alicloudroscdkcore.RosResource
	Bucket() interface{}
	SetBucket(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	ObjectAcl() interface{}
	SetObjectAcl(val interface{})
	ObjectKey() interface{}
	SetObjectKey(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::OSS::ObjectAcl`, which is used to modify the access control list (ACL) of an Object Storage Service (OSS) object.

func NewRosObjectAcl 

func NewRosObjectAcl(scope alicloudroscdkcore.Construct, id *string, props *RosObjectAclProps, enableResourcePropertyConstraint *bool) RosObjectAcl

type RosObjectAclProps 

type RosObjectAclProps struct {
	Bucket    interface{} `field:"required" json:"bucket" yaml:"bucket"`
	ObjectAcl interface{} `field:"required" json:"objectAcl" yaml:"objectAcl"`
	ObjectKey interface{} `field:"required" json:"objectKey" yaml:"objectKey"`
}

Properties for defining a `RosObjectAcl`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-objectacl

type RosWebsite 

type RosWebsite interface {
	alicloudroscdkcore.RosResource
	BucketName() interface{}
	SetBucketName(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	WebsiteConfiguration() interface{}
	SetWebsiteConfiguration(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::OSS::Website`, which is used to configure static website hosting and redirection rules for an Object Storage Service (OSS) bucket.

func NewRosWebsite 

func NewRosWebsite(scope alicloudroscdkcore.Construct, id *string, props *RosWebsiteProps, enableResourcePropertyConstraint *bool) RosWebsite

type RosWebsiteProps 

type RosWebsiteProps struct {
	BucketName           interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	WebsiteConfiguration interface{} `field:"optional" json:"websiteConfiguration" yaml:"websiteConfiguration"`
}

Properties for defining a `RosWebsite`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-website

type RosWebsite_ConditionProperty 

type RosWebsite_ConditionProperty struct {
	HttpErrorCodeReturnedEquals interface{} `field:"optional" json:"httpErrorCodeReturnedEquals" yaml:"httpErrorCodeReturnedEquals"`
	IncludeHeaders              interface{} `field:"optional" json:"includeHeaders" yaml:"includeHeaders"`
	KeyPrefixEquals             interface{} `field:"optional" json:"keyPrefixEquals" yaml:"keyPrefixEquals"`
	KeySuffixEquals             interface{} `field:"optional" json:"keySuffixEquals" yaml:"keySuffixEquals"`
}

type RosWebsite_ErrorDocumentProperty 

type RosWebsite_ErrorDocumentProperty struct {
	Key        interface{} `field:"required" json:"key" yaml:"key"`
	HttpStatus interface{} `field:"optional" json:"httpStatus" yaml:"httpStatus"`
}

type RosWebsite_IncludeHeadersProperty 

type RosWebsite_IncludeHeadersProperty struct {
	Key      interface{} `field:"required" json:"key" yaml:"key"`
	EqualsTo interface{} `field:"optional" json:"equalsTo" yaml:"equalsTo"`
}

type RosWebsite_IndexDocumentProperty 

type RosWebsite_IndexDocumentProperty struct {
	Suffix        interface{} `field:"required" json:"suffix" yaml:"suffix"`
	SupportSubDir interface{} `field:"optional" json:"supportSubDir" yaml:"supportSubDir"`
	Type          interface{} `field:"optional" json:"type" yaml:"type"`
}

type RosWebsite_MirrorHeadersProperty 

type RosWebsite_MirrorHeadersProperty struct {
	Pass    interface{} `field:"optional" json:"pass" yaml:"pass"`
	PassAll interface{} `field:"optional" json:"passAll" yaml:"passAll"`
	Remove  interface{} `field:"optional" json:"remove" yaml:"remove"`
	Sets    interface{} `field:"optional" json:"sets" yaml:"sets"`
}

type RosWebsite_RedirectProperty 

type RosWebsite_RedirectProperty struct {
	RedirectType          interface{} `field:"required" json:"redirectType" yaml:"redirectType"`
	EnableReplacePrefix   interface{} `field:"optional" json:"enableReplacePrefix" yaml:"enableReplacePrefix"`
	HostName              interface{} `field:"optional" json:"hostName" yaml:"hostName"`
	HttpRedirectCode      interface{} `field:"optional" json:"httpRedirectCode" yaml:"httpRedirectCode"`
	MirrorCheckMd5        interface{} `field:"optional" json:"mirrorCheckMd5" yaml:"mirrorCheckMd5"`
	MirrorFollowRedirect  interface{} `field:"optional" json:"mirrorFollowRedirect" yaml:"mirrorFollowRedirect"`
	MirrorHeaders         interface{} `field:"optional" json:"mirrorHeaders" yaml:"mirrorHeaders"`
	MirrorPassQueryString interface{} `field:"optional" json:"mirrorPassQueryString" yaml:"mirrorPassQueryString"`
	MirrorUrl             interface{} `field:"optional" json:"mirrorUrl" yaml:"mirrorUrl"`
	PassQueryString       interface{} `field:"optional" json:"passQueryString" yaml:"passQueryString"`
	Protocol              interface{} `field:"optional" json:"protocol" yaml:"protocol"`
	ReplaceKeyPrefixWith  interface{} `field:"optional" json:"replaceKeyPrefixWith" yaml:"replaceKeyPrefixWith"`
	ReplaceKeyWith        interface{} `field:"optional" json:"replaceKeyWith" yaml:"replaceKeyWith"`
}

type RosWebsite_RoutingRulesProperty 

type RosWebsite_RoutingRulesProperty struct {
	Condition  interface{} `field:"required" json:"condition" yaml:"condition"`
	Redirect   interface{} `field:"required" json:"redirect" yaml:"redirect"`
	RuleNumber interface{} `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
}

type RosWebsite_SetsProperty 

type RosWebsite_SetsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"required" json:"value" yaml:"value"`
}

type RosWebsite_WebsiteConfigurationProperty 

type RosWebsite_WebsiteConfigurationProperty struct {
	ErrorDocument interface{} `field:"optional" json:"errorDocument" yaml:"errorDocument"`
	IndexDocument interface{} `field:"optional" json:"indexDocument" yaml:"indexDocument"`
	RoutingRules  interface{} `field:"optional" json:"routingRules" yaml:"routingRules"`
}

type Website 

type Website interface {
	alicloudroscdkcore.Resource
	IWebsite
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *WebsiteProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::OSS::Website`, which is used to configure static website hosting and redirection rules for an Object Storage Service (OSS) bucket.

func NewWebsite 

func NewWebsite(scope alicloudroscdkcore.Construct, id *string, props *WebsiteProps, enableResourcePropertyConstraint *bool) Website

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type WebsiteProps 

type WebsiteProps struct {
	// Property bucketName: Bucket name.
	BucketName interface{} `field:"required" json:"bucketName" yaml:"bucketName"`
	// Property websiteConfiguration: Website configuration.
	WebsiteConfiguration interface{} `field:"optional" json:"websiteConfiguration" yaml:"websiteConfiguration"`
}

Properties for defining a `Website`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oss-website

Source Files

View all Source files

Directories

Path Synopsis
internal
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.