datasource

package
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: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRosVault_Override added in v1.5.0 

func NewRosVault_Override(r RosVault, scope alicloudroscdkcore.Construct, id *string, props *RosVaultProps, enableResourcePropertyConstraint *bool)

func NewRosVaults_Override 

func NewRosVaults_Override(r RosVaults, scope alicloudroscdkcore.Construct, id *string, props *RosVaultsProps, enableResourcePropertyConstraint *bool)

func NewVault_Override added in v1.5.0 

func NewVault_Override(v Vault, scope alicloudroscdkcore.Construct, id *string, props *VaultProps, enableResourcePropertyConstraint *bool)

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

func NewVaults_Override 

func NewVaults_Override(v Vaults, scope alicloudroscdkcore.Construct, id *string, props *VaultsProps, enableResourcePropertyConstraint *bool)

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

func RosVault_IsConstruct added in v1.5.0 

func RosVault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosVault_IsRosElement added in v1.5.0 

func RosVault_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 RosVault_IsRosResource added in v1.5.0 

func RosVault_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosVault_ROS_RESOURCE_TYPE_NAME added in v1.5.0 

func RosVault_ROS_RESOURCE_TYPE_NAME() *string

func RosVaults_IsConstruct 

func RosVaults_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosVaults_IsRosElement 

func RosVaults_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 RosVaults_IsRosResource 

func RosVaults_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosVaults_ROS_RESOURCE_TYPE_NAME 

func RosVaults_ROS_RESOURCE_TYPE_NAME() *string

func Vault_IsConstruct added in v1.5.0 

func Vault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Vaults_IsConstruct 

func Vaults_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type IVault added in v1.6.0 

type IVault interface {
	alicloudroscdkcore.IResource
	// Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
	AttrBackupPlanStatistics() interface{}
	// Attribute BytesDone: The amount of data that is backed up.
	//
	// Unit: bytes.
	AttrBytesDone() interface{}
	// Attribute CreateTime: The creation time of the backup vault.
	AttrCreateTime() interface{}
	// Attribute Dedup: Indicates whether the deduplication feature is enabled.
	AttrDedup() interface{}
	// Attribute Description: The description of the backup vault.
	AttrDescription() interface{}
	// Attribute IndexAvailable: Indicates whether indexes are available.
	//
	// Indexes are available when they are not being updated.
	AttrIndexAvailable() interface{}
	// Attribute IndexLevel: The index level.
	AttrIndexLevel() interface{}
	// Attribute IndexUpdateTime: The time when the index was updated.
	AttrIndexUpdateTime() interface{}
	// Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
	//
	// The value is a UNIX timestamp. Unit: seconds.
	AttrLatestReplicationTime() interface{}
	// Attribute PaymentType: The payment type of the backup vault.
	AttrPaymentType() interface{}
	// Attribute RedundancyType: The data redundancy type of the backup vault.
	AttrRedundancyType() interface{}
	// Attribute Replication: Indicates whether the backup vault is a remote backup vault.
	AttrReplication() interface{}
	// Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
	AttrReplicationProgress() interface{}
	// Attribute ReplicationSourceRegionId: The ID of the region in which the source vault resides.
	//
	// This parameter is valid only for remote backup vaults.
	AttrReplicationSourceRegionId() interface{}
	// Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
	AttrReplicationSourceVaultId() interface{}
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() interface{}
	// Attribute Retention: The retention period of the backup vault.
	//
	// Unit: days.
	AttrRetention() interface{}
	// Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
	AttrSearchEnabled() interface{}
	// Attribute SourceTypes: The data source types of the backup vault.
	AttrSourceTypes() interface{}
	// Attribute StorageSize: The usage of the backup vault.
	//
	// Unit: bytes.
	AttrStorageSize() interface{}
	// Attribute Tags: The tags of the backup vault.
	AttrTags() interface{}
	// Attribute TrialInfo: The free trial information.
	AttrTrialInfo() interface{}
	// Attribute UpdatedTime: The time when the backup vault was updated.
	//
	// The value is a UNIX timestamp. Unit: seconds.
	AttrUpdatedTime() interface{}
	// Attribute VaultId: The ID of the backup vault.
	AttrVaultId() interface{}
	// Attribute VaultName: The name of the backup vault.
	AttrVaultName() interface{}
	// Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
	//
	// This parameter is valid only for remote backup vaults.
	AttrVaultStatusMessage() interface{}
	// Attribute VaultStorageClass: Backup repository storage type.
	//
	// The value is only **STANDARD**, which indicates STANDARD storage.
	AttrVaultStorageClass() interface{}
	// Attribute VaultType: The type of the backup vault.
	AttrVaultType() interface{}
	Props() *VaultProps
}

Represents a `Vault`.

type IVaults added in v1.6.0 

type IVaults interface {
	alicloudroscdkcore.IResource
	// Attribute VaultIds: The list of vault IDs.
	AttrVaultIds() interface{}
	// Attribute Vaults: The list of vaults.
	AttrVaults() interface{}
	Props() *VaultsProps
}

Represents a `Vaults`.

type RosVault added in v1.5.0 

type RosVault interface {
	alicloudroscdkcore.RosResource
	AttrBackupPlanStatistics() alicloudroscdkcore.IResolvable
	AttrBytesDone() alicloudroscdkcore.IResolvable
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrDedup() alicloudroscdkcore.IResolvable
	AttrDescription() alicloudroscdkcore.IResolvable
	AttrIndexAvailable() alicloudroscdkcore.IResolvable
	AttrIndexLevel() alicloudroscdkcore.IResolvable
	AttrIndexUpdateTime() alicloudroscdkcore.IResolvable
	AttrLatestReplicationTime() alicloudroscdkcore.IResolvable
	AttrPaymentType() alicloudroscdkcore.IResolvable
	AttrRedundancyType() alicloudroscdkcore.IResolvable
	AttrReplication() alicloudroscdkcore.IResolvable
	AttrReplicationProgress() alicloudroscdkcore.IResolvable
	AttrReplicationSourceRegionId() alicloudroscdkcore.IResolvable
	AttrReplicationSourceVaultId() alicloudroscdkcore.IResolvable
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	AttrRetention() alicloudroscdkcore.IResolvable
	AttrSearchEnabled() alicloudroscdkcore.IResolvable
	AttrSourceTypes() alicloudroscdkcore.IResolvable
	AttrStorageSize() alicloudroscdkcore.IResolvable
	AttrTags() alicloudroscdkcore.IResolvable
	AttrTrialInfo() alicloudroscdkcore.IResolvable
	AttrUpdatedTime() alicloudroscdkcore.IResolvable
	AttrVaultId() alicloudroscdkcore.IResolvable
	AttrVaultName() alicloudroscdkcore.IResolvable
	AttrVaultStatusMessage() alicloudroscdkcore.IResolvable
	AttrVaultStorageClass() alicloudroscdkcore.IResolvable
	AttrVaultType() alicloudroscdkcore.IResolvable
	// 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
	RefreshOptions() interface{}
	SetRefreshOptions(val interface{})
	// 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{}
	VaultId() interface{}
	SetVaultId(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 `DATASOURCE::HBR::Vault`.

func NewRosVault added in v1.5.0 

func NewRosVault(scope alicloudroscdkcore.Construct, id *string, props *RosVaultProps, enableResourcePropertyConstraint *bool) RosVault

type RosVaultProps added in v1.5.0 

type RosVaultProps struct {
	VaultId        interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `RosVault`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-hbr-vault

type RosVaults 

type RosVaults interface {
	alicloudroscdkcore.RosResource
	AttrVaultIds() alicloudroscdkcore.IResolvable
	AttrVaults() alicloudroscdkcore.IResolvable
	// 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
	RefreshOptions() interface{}
	SetRefreshOptions(val interface{})
	// 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{}
	VaultId() interface{}
	SetVaultId(val interface{})
	VaultType() interface{}
	SetVaultType(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 `DATASOURCE::HBR::Vaults`, which is used to query the basic information about backup vaults.

func NewRosVaults 

func NewRosVaults(scope alicloudroscdkcore.Construct, id *string, props *RosVaultsProps, enableResourcePropertyConstraint *bool) RosVaults

type RosVaultsProps 

type RosVaultsProps struct {
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
	VaultId        interface{} `field:"optional" json:"vaultId" yaml:"vaultId"`
	VaultType      interface{} `field:"optional" json:"vaultType" yaml:"vaultType"`
}

Properties for defining a `RosVaults`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-hbr-vaults

type Vault added in v1.5.0 

type Vault interface {
	alicloudroscdkcore.Resource
	IVault
	// Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
	AttrBackupPlanStatistics() interface{}
	// Attribute BytesDone: The amount of data that is backed up.
	//
	// Unit: bytes.
	AttrBytesDone() interface{}
	// Attribute CreateTime: The creation time of the backup vault.
	AttrCreateTime() interface{}
	// Attribute Dedup: Indicates whether the deduplication feature is enabled.
	AttrDedup() interface{}
	// Attribute Description: The description of the backup vault.
	AttrDescription() interface{}
	// Attribute IndexAvailable: Indicates whether indexes are available.
	//
	// Indexes are available when they are not being updated.
	AttrIndexAvailable() interface{}
	// Attribute IndexLevel: The index level.
	AttrIndexLevel() interface{}
	// Attribute IndexUpdateTime: The time when the index was updated.
	AttrIndexUpdateTime() interface{}
	// Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
	//
	// The value is a UNIX timestamp. Unit: seconds.
	AttrLatestReplicationTime() interface{}
	// Attribute PaymentType: The payment type of the backup vault.
	AttrPaymentType() interface{}
	// Attribute RedundancyType: The data redundancy type of the backup vault.
	AttrRedundancyType() interface{}
	// Attribute Replication: Indicates whether the backup vault is a remote backup vault.
	AttrReplication() interface{}
	// Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
	AttrReplicationProgress() interface{}
	// Attribute ReplicationSourceRegionId: The ID of the region in which the source vault resides.
	//
	// This parameter is valid only for remote backup vaults.
	AttrReplicationSourceRegionId() interface{}
	// Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
	AttrReplicationSourceVaultId() interface{}
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() interface{}
	// Attribute Retention: The retention period of the backup vault.
	//
	// Unit: days.
	AttrRetention() interface{}
	// Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
	AttrSearchEnabled() interface{}
	// Attribute SourceTypes: The data source types of the backup vault.
	AttrSourceTypes() interface{}
	// Attribute StorageSize: The usage of the backup vault.
	//
	// Unit: bytes.
	AttrStorageSize() interface{}
	// Attribute Tags: The tags of the backup vault.
	AttrTags() interface{}
	// Attribute TrialInfo: The free trial information.
	AttrTrialInfo() interface{}
	// Attribute UpdatedTime: The time when the backup vault was updated.
	//
	// The value is a UNIX timestamp. Unit: seconds.
	AttrUpdatedTime() interface{}
	// Attribute VaultId: The ID of the backup vault.
	AttrVaultId() interface{}
	// Attribute VaultName: The name of the backup vault.
	AttrVaultName() interface{}
	// Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
	//
	// This parameter is valid only for remote backup vaults.
	AttrVaultStatusMessage() interface{}
	// Attribute VaultStorageClass: Backup repository storage type.
	//
	// The value is only **STANDARD**, which indicates STANDARD storage.
	AttrVaultStorageClass() interface{}
	// Attribute VaultType: The type of the backup vault.
	AttrVaultType() 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() *VaultProps
	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 `DATASOURCE::HBR::Vault`.

func NewVault added in v1.5.0 

func NewVault(scope alicloudroscdkcore.Construct, id *string, props *VaultProps, enableResourcePropertyConstraint *bool) Vault

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

type VaultProps added in v1.5.0 

type VaultProps struct {
	// Property vaultId: The ID of the backup vault.
	VaultId interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
	// Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
	//
	// Valid values:
	// - Never: Never refresh the datasource resource when the stack is updated.
	// - Always: Always refresh the datasource resource when the stack is updated.
	// Default is Never.
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}

Properties for defining a `Vault`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-hbr-vault

type Vaults 

type Vaults interface {
	alicloudroscdkcore.Resource
	IVaults
	// Attribute VaultIds: The list of vault IDs.
	AttrVaultIds() interface{}
	// Attribute Vaults: The list of vaults.
	AttrVaults() 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() *VaultsProps
	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 `DATASOURCE::HBR::Vaults`, which is used to query the basic information about backup vaults.

func NewVaults 

func NewVaults(scope alicloudroscdkcore.Construct, id *string, props *VaultsProps, enableResourcePropertyConstraint *bool) Vaults

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

type VaultsProps 

type VaultsProps struct {
	// Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
	//
	// Valid values:
	// - Never: Never refresh the datasource resource when the stack is updated.
	// - Always: Always refresh the datasource resource when the stack is updated.
	// Default is Never.
	RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
	// Property vaultId: VaultId.
	VaultId interface{} `field:"optional" json:"vaultId" yaml:"vaultId"`
	// Property vaultType: Vault type.
	//
	// Value
	// - **STANDARD**, which indicates a common backup vault.
	// - **OTS_BACKUP**, indicating OTS backup vault.
	VaultType interface{} `field:"optional" json:"vaultType" yaml:"vaultType"`
}

Properties for defining a `Vaults`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-hbr-vaults

Source Files

View all Source files

Directories

Path Synopsis

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.