Documentation
¶
Overview ¶
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Index ¶
- func HostGroup_IsConstruct(x interface{}) *bool
- func NewHostGroup_Override(h HostGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPipelineRelations_Override(p PipelineRelations, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPipelineRun_Override(p PipelineRun, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPipeline_Override(p Pipeline, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosHostGroup_Override(r RosHostGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPipelineRelations_Override(r RosPipelineRelations, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPipelineRun_Override(r RosPipelineRun, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPipeline_Override(r RosPipeline, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosVariableGroup_Override(r RosVariableGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewVariableGroup_Override(v VariableGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func PipelineRelations_IsConstruct(x interface{}) *bool
- func PipelineRun_IsConstruct(x interface{}) *bool
- func Pipeline_IsConstruct(x interface{}) *bool
- func RosHostGroup_IsConstruct(x interface{}) *bool
- func RosHostGroup_IsRosElement(x interface{}) *bool
- func RosHostGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosHostGroup_ROS_RESOURCE_TYPE_NAME() *string
- func RosPipelineRelations_IsConstruct(x interface{}) *bool
- func RosPipelineRelations_IsRosElement(x interface{}) *bool
- func RosPipelineRelations_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPipelineRelations_ROS_RESOURCE_TYPE_NAME() *string
- func RosPipelineRun_IsConstruct(x interface{}) *bool
- func RosPipelineRun_IsRosElement(x interface{}) *bool
- func RosPipelineRun_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPipelineRun_ROS_RESOURCE_TYPE_NAME() *string
- func RosPipeline_IsConstruct(x interface{}) *bool
- func RosPipeline_IsRosElement(x interface{}) *bool
- func RosPipeline_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPipeline_ROS_RESOURCE_TYPE_NAME() *string
- func RosVariableGroup_IsConstruct(x interface{}) *bool
- func RosVariableGroup_IsRosElement(x interface{}) *bool
- func RosVariableGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosVariableGroup_ROS_RESOURCE_TYPE_NAME() *string
- func VariableGroup_IsConstruct(x interface{}) *bool
- type HostGroup
- type HostGroupProps
- type IHostGroup
- type IPipeline
- type IPipelineRelations
- type IPipelineRun
- type IVariableGroup
- type Pipeline
- type PipelineProps
- type PipelineRelations
- type PipelineRelationsProps
- type PipelineRun
- type PipelineRunProps
- type RosHostGroup
- type RosHostGroupProps
- type RosHostGroup_MachineInfosProperty
- type RosPipeline
- type RosPipelineProps
- type RosPipelineRelations
- type RosPipelineRelationsProps
- type RosPipelineRun
- type RosPipelineRunProps
- type RosVariableGroup
- type RosVariableGroupProps
- type RosVariableGroup_VariablesProperty
- type VariableGroup
- type VariableGroupProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HostGroup_IsConstruct ¶
func HostGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewHostGroup_Override ¶
func NewHostGroup_Override(h HostGroup, scope alicloudroscdkcore.Construct, id *string, props *HostGroupProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPipelineRelations_Override ¶
func NewPipelineRelations_Override(p PipelineRelations, scope alicloudroscdkcore.Construct, id *string, props *PipelineRelationsProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPipelineRun_Override ¶
func NewPipelineRun_Override(p PipelineRun, scope alicloudroscdkcore.Construct, id *string, props *PipelineRunProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPipeline_Override ¶
func NewPipeline_Override(p Pipeline, scope alicloudroscdkcore.Construct, id *string, props *PipelineProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosHostGroup_Override ¶
func NewRosHostGroup_Override(r RosHostGroup, scope alicloudroscdkcore.Construct, id *string, props *RosHostGroupProps, enableResourcePropertyConstraint *bool)
func NewRosPipelineRelations_Override ¶
func NewRosPipelineRelations_Override(r RosPipelineRelations, scope alicloudroscdkcore.Construct, id *string, props *RosPipelineRelationsProps, enableResourcePropertyConstraint *bool)
func NewRosPipelineRun_Override ¶
func NewRosPipelineRun_Override(r RosPipelineRun, scope alicloudroscdkcore.Construct, id *string, props *RosPipelineRunProps, enableResourcePropertyConstraint *bool)
func NewRosPipeline_Override ¶
func NewRosPipeline_Override(r RosPipeline, scope alicloudroscdkcore.Construct, id *string, props *RosPipelineProps, enableResourcePropertyConstraint *bool)
func NewRosVariableGroup_Override ¶
func NewRosVariableGroup_Override(r RosVariableGroup, scope alicloudroscdkcore.Construct, id *string, props *RosVariableGroupProps, enableResourcePropertyConstraint *bool)
func NewVariableGroup_Override ¶
func NewVariableGroup_Override(v VariableGroup, scope alicloudroscdkcore.Construct, id *string, props *VariableGroupProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func PipelineRelations_IsConstruct ¶
func PipelineRelations_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func PipelineRun_IsConstruct ¶
func PipelineRun_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Pipeline_IsConstruct ¶
func Pipeline_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosHostGroup_IsConstruct ¶
func RosHostGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosHostGroup_IsRosElement ¶
func RosHostGroup_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 RosHostGroup_IsRosResource ¶
func RosHostGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosHostGroup_ROS_RESOURCE_TYPE_NAME ¶
func RosHostGroup_ROS_RESOURCE_TYPE_NAME() *string
func RosPipelineRelations_IsConstruct ¶
func RosPipelineRelations_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPipelineRelations_IsRosElement ¶
func RosPipelineRelations_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 RosPipelineRelations_IsRosResource ¶
func RosPipelineRelations_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPipelineRelations_ROS_RESOURCE_TYPE_NAME ¶
func RosPipelineRelations_ROS_RESOURCE_TYPE_NAME() *string
func RosPipelineRun_IsConstruct ¶
func RosPipelineRun_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPipelineRun_IsRosElement ¶
func RosPipelineRun_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 RosPipelineRun_IsRosResource ¶
func RosPipelineRun_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPipelineRun_ROS_RESOURCE_TYPE_NAME ¶
func RosPipelineRun_ROS_RESOURCE_TYPE_NAME() *string
func RosPipeline_IsConstruct ¶
func RosPipeline_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPipeline_IsRosElement ¶
func RosPipeline_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 RosPipeline_IsRosResource ¶
func RosPipeline_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPipeline_ROS_RESOURCE_TYPE_NAME ¶
func RosPipeline_ROS_RESOURCE_TYPE_NAME() *string
func RosVariableGroup_IsConstruct ¶
func RosVariableGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosVariableGroup_IsRosElement ¶
func RosVariableGroup_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 RosVariableGroup_IsRosResource ¶
func RosVariableGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosVariableGroup_ROS_RESOURCE_TYPE_NAME ¶
func RosVariableGroup_ROS_RESOURCE_TYPE_NAME() *string
func VariableGroup_IsConstruct ¶
func VariableGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
Types ¶
type HostGroup ¶
type HostGroup interface { alicloudroscdkcore.Resource IHostGroup // Attribute HostGroupId: The id of the host group. AttrHostGroupId() 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.IResourceEnvironment 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() *HostGroupProps 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::DEVOPS::HostGroup`, which is used to create a host group.
func NewHostGroup ¶
func NewHostGroup(scope alicloudroscdkcore.Construct, id *string, props *HostGroupProps, enableResourcePropertyConstraint *bool) HostGroup
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type HostGroupProps ¶
type HostGroupProps struct { // Property name: Host group name. Name interface{} `field:"required" json:"name" yaml:"name"` // Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` // Property serviceConnectionId: Service connection. ServiceConnectionId interface{} `field:"required" json:"serviceConnectionId" yaml:"serviceConnectionId"` // Property aliyunRegion: The aliyun region. AliyunRegion interface{} `field:"optional" json:"aliyunRegion" yaml:"aliyunRegion"` // Property ecsLabelKey: The tag key of the ECS. EcsLabelKey interface{} `field:"optional" json:"ecsLabelKey" yaml:"ecsLabelKey"` // Property ecsLabelValue: The tag value of the ECS. EcsLabelValue interface{} `field:"optional" json:"ecsLabelValue" yaml:"ecsLabelValue"` // Property ecsType: The type of ECS, currently only supports ECS_ALIYUN. EcsType interface{} `field:"optional" json:"ecsType" yaml:"ecsType"` // Property envId: Environment id. EnvId interface{} `field:"optional" json:"envId" yaml:"envId"` // Property machineInfos: The machine infos. MachineInfos interface{} `field:"optional" json:"machineInfos" yaml:"machineInfos"` // Property tagIds: The ids of tag. TagIds interface{} `field:"optional" json:"tagIds" yaml:"tagIds"` // Property type: Host group type, currently only supports ECS. Type interface{} `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `HostGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-hostgroup
type IHostGroup ¶ added in v1.6.0
type IHostGroup interface { alicloudroscdkcore.IResource // Attribute HostGroupId: The id of the host group. AttrHostGroupId() interface{} Props() *HostGroupProps }
Represents a `HostGroup`.
type IPipeline ¶ added in v1.6.0
type IPipeline interface { alicloudroscdkcore.IResource // Attribute PipelineId: Pipeline id. AttrPipelineId() interface{} Props() *PipelineProps }
Represents a `Pipeline`.
type IPipelineRelations ¶ added in v1.6.0
type IPipelineRelations interface { alicloudroscdkcore.IResource Props() *PipelineRelationsProps }
Represents a `PipelineRelations`.
type IPipelineRun ¶ added in v1.6.0
type IPipelineRun interface { alicloudroscdkcore.IResource // Attribute PipelineRunId: Pipeline run id. AttrPipelineRunId() interface{} Props() *PipelineRunProps }
Represents a `PipelineRun`.
type IVariableGroup ¶ added in v1.6.0
type IVariableGroup interface { alicloudroscdkcore.IResource // Attribute VariableGroupId: Variable group id. AttrVariableGroupId() interface{} Props() *VariableGroupProps }
Represents a `VariableGroup`.
type Pipeline ¶
type Pipeline interface { alicloudroscdkcore.Resource IPipeline // Attribute PipelineId: Pipeline id. AttrPipelineId() 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.IResourceEnvironment 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() *PipelineProps 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::DEVOPS::Pipeline`, which is used to create a pipeline.
YAML-based pipelines are supported.
func NewPipeline ¶
func NewPipeline(scope alicloudroscdkcore.Construct, id *string, props *PipelineProps, enableResourcePropertyConstraint *bool) Pipeline
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PipelineProps ¶
type PipelineProps struct { // Property content: Pipeline description in YAML format. Content interface{} `field:"required" json:"content" yaml:"content"` // Property name: Pipeline name. Name interface{} `field:"required" json:"name" yaml:"name"` // Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` }
Properties for defining a `Pipeline`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipeline
type PipelineRelations ¶
type PipelineRelations interface { alicloudroscdkcore.Resource IPipelineRelations 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.IResourceEnvironment 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() *PipelineRelationsProps 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::DEVOPS::PipelineRelations`, which is used to associate resources with a pipeline.
func NewPipelineRelations ¶
func NewPipelineRelations(scope alicloudroscdkcore.Construct, id *string, props *PipelineRelationsProps, enableResourcePropertyConstraint *bool) PipelineRelations
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PipelineRelationsProps ¶
type PipelineRelationsProps struct { // Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` // Property pipelineId: The pipeline ID, which can be obtained from the pipeline link. PipelineId interface{} `field:"required" json:"pipelineId" yaml:"pipelineId"` // Property relObjectIds: Ids of the associated resource. // // For now, only variable group ids are supported. RelObjectIds interface{} `field:"required" json:"relObjectIds" yaml:"relObjectIds"` // Property relObjectType: Associated resource type. // // Valid values: // - VARIABLE_GROUP // - OOS_APP_ID // For now, only VARIABLE GROUP is supported. RelObjectType interface{} `field:"required" json:"relObjectType" yaml:"relObjectType"` }
Properties for defining a `PipelineRelations`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerelations
type PipelineRun ¶
type PipelineRun interface { alicloudroscdkcore.Resource IPipelineRun // Attribute PipelineRunId: Pipeline run id. AttrPipelineRunId() 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.IResourceEnvironment 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() *PipelineRunProps 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::DEVOPS::PipelineRun`, which is used to run a pipeline.
func NewPipelineRun ¶
func NewPipelineRun(scope alicloudroscdkcore.Construct, id *string, props *PipelineRunProps, enableResourcePropertyConstraint *bool) PipelineRun
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PipelineRunProps ¶
type PipelineRunProps struct { // Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` // Property pipelineId: The pipeline ID, which can be obtained from the pipeline link. PipelineId interface{} `field:"required" json:"pipelineId" yaml:"pipelineId"` // Property params: Pipeline operating parameters. // // Keys: // - **branchModeBranchs**: Branch mode runs branches. // - **envs**: Running variables. // - **runningBranchs**: Running branches whose key is the warehouse address. // - **runningTags**: Running tags whose key is the warehouse address. Params interface{} `field:"optional" json:"params" yaml:"params"` // Property sync: Whether to wait synchronously for the result of the pipeline execution. // // If you select true, the resource will not be created until the pipeline is complete. **Default is false.** // Note: Do not set this option to true when the pipeline has a pause policy configured, as publishing requires manual intervention and synchronization is not appropriate. Sync interface{} `field:"optional" json:"sync" yaml:"sync"` // Property timeout: Maximum wait time for pipeline execution in minutes. // // This parameter need only be configured if Sync is set to true. **Default is 10.** Timeout interface{} `field:"optional" json:"timeout" yaml:"timeout"` }
Properties for defining a `PipelineRun`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerun
type RosHostGroup ¶
type RosHostGroup interface { alicloudroscdkcore.RosResource AliyunRegion() interface{} SetAliyunRegion(val interface{}) AttrHostGroupId() 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 EcsLabelKey() interface{} SetEcsLabelKey(val interface{}) EcsLabelValue() interface{} SetEcsLabelValue(val interface{}) EcsType() interface{} SetEcsType(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvId() interface{} SetEnvId(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 MachineInfos() interface{} SetMachineInfos(val interface{}) Name() interface{} SetName(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode OrganizationId() interface{} SetOrganizationId(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 ServiceConnectionId() interface{} SetServiceConnectionId(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack TagIds() interface{} SetTagIds(val interface{}) Type() interface{} SetType(val 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{} 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::DEVOPS::HostGroup`, which is used to create a host group.
func NewRosHostGroup ¶
func NewRosHostGroup(scope alicloudroscdkcore.Construct, id *string, props *RosHostGroupProps, enableResourcePropertyConstraint *bool) RosHostGroup
type RosHostGroupProps ¶
type RosHostGroupProps struct { Name interface{} `field:"required" json:"name" yaml:"name"` OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` ServiceConnectionId interface{} `field:"required" json:"serviceConnectionId" yaml:"serviceConnectionId"` AliyunRegion interface{} `field:"optional" json:"aliyunRegion" yaml:"aliyunRegion"` EcsLabelKey interface{} `field:"optional" json:"ecsLabelKey" yaml:"ecsLabelKey"` EcsLabelValue interface{} `field:"optional" json:"ecsLabelValue" yaml:"ecsLabelValue"` EcsType interface{} `field:"optional" json:"ecsType" yaml:"ecsType"` EnvId interface{} `field:"optional" json:"envId" yaml:"envId"` MachineInfos interface{} `field:"optional" json:"machineInfos" yaml:"machineInfos"` TagIds interface{} `field:"optional" json:"tagIds" yaml:"tagIds"` Type interface{} `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `RosHostGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-hostgroup
type RosHostGroup_MachineInfosProperty ¶
type RosHostGroup_MachineInfosProperty struct { MachineSn interface{} `field:"required" json:"machineSn" yaml:"machineSn"` AliyunRegionId interface{} `field:"optional" json:"aliyunRegionId" yaml:"aliyunRegionId"` InstanceName interface{} `field:"optional" json:"instanceName" yaml:"instanceName"` Ip interface{} `field:"optional" json:"ip" yaml:"ip"` }
type RosPipeline ¶
type RosPipeline interface { alicloudroscdkcore.RosResource AttrPipelineId() alicloudroscdkcore.IResolvable Content() interface{} SetContent(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 Name() interface{} SetName(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode OrganizationId() interface{} SetOrganizationId(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::DEVOPS::Pipeline`, which is used to create a pipeline.
YAML-based pipelines are supported.
func NewRosPipeline ¶
func NewRosPipeline(scope alicloudroscdkcore.Construct, id *string, props *RosPipelineProps, enableResourcePropertyConstraint *bool) RosPipeline
type RosPipelineProps ¶
type RosPipelineProps struct { Content interface{} `field:"required" json:"content" yaml:"content"` Name interface{} `field:"required" json:"name" yaml:"name"` OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` }
Properties for defining a `RosPipeline`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipeline
type RosPipelineRelations ¶
type RosPipelineRelations interface { alicloudroscdkcore.RosResource // 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 OrganizationId() interface{} SetOrganizationId(val interface{}) PipelineId() interface{} SetPipelineId(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 RelObjectIds() interface{} SetRelObjectIds(val interface{}) RelObjectType() interface{} SetRelObjectType(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{} 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::DEVOPS::PipelineRelations`, which is used to associate resources with a pipeline.
func NewRosPipelineRelations ¶
func NewRosPipelineRelations(scope alicloudroscdkcore.Construct, id *string, props *RosPipelineRelationsProps, enableResourcePropertyConstraint *bool) RosPipelineRelations
type RosPipelineRelationsProps ¶
type RosPipelineRelationsProps struct { OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` PipelineId interface{} `field:"required" json:"pipelineId" yaml:"pipelineId"` RelObjectIds interface{} `field:"required" json:"relObjectIds" yaml:"relObjectIds"` RelObjectType interface{} `field:"required" json:"relObjectType" yaml:"relObjectType"` }
Properties for defining a `RosPipelineRelations`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerelations
type RosPipelineRun ¶
type RosPipelineRun interface { alicloudroscdkcore.RosResource AttrPipelineRunId() 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 OrganizationId() interface{} SetOrganizationId(val interface{}) Params() interface{} SetParams(val interface{}) PipelineId() interface{} SetPipelineId(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 Sync() interface{} SetSync(val interface{}) Timeout() interface{} SetTimeout(val 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{} 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::DEVOPS::PipelineRun`, which is used to run a pipeline.
func NewRosPipelineRun ¶
func NewRosPipelineRun(scope alicloudroscdkcore.Construct, id *string, props *RosPipelineRunProps, enableResourcePropertyConstraint *bool) RosPipelineRun
type RosPipelineRunProps ¶
type RosPipelineRunProps struct { OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` PipelineId interface{} `field:"required" json:"pipelineId" yaml:"pipelineId"` Params interface{} `field:"optional" json:"params" yaml:"params"` Sync interface{} `field:"optional" json:"sync" yaml:"sync"` Timeout interface{} `field:"optional" json:"timeout" yaml:"timeout"` }
Properties for defining a `RosPipelineRun`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerun
type RosVariableGroup ¶
type RosVariableGroup interface { alicloudroscdkcore.RosResource AttrVariableGroupId() 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 Description() interface{} SetDescription(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 Name() interface{} SetName(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode OrganizationId() interface{} SetOrganizationId(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{} Variables() interface{} SetVariables(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::DEVOPS::VariableGroup`, which is used to create a variable group.
func NewRosVariableGroup ¶
func NewRosVariableGroup(scope alicloudroscdkcore.Construct, id *string, props *RosVariableGroupProps, enableResourcePropertyConstraint *bool) RosVariableGroup
type RosVariableGroupProps ¶
type RosVariableGroupProps struct { Name interface{} `field:"required" json:"name" yaml:"name"` OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` Variables interface{} `field:"required" json:"variables" yaml:"variables"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `RosVariableGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-variablegroup
type RosVariableGroup_VariablesProperty ¶
type RosVariableGroup_VariablesProperty struct { IsEncrypted interface{} `field:"required" json:"isEncrypted" yaml:"isEncrypted"` Name interface{} `field:"required" json:"name" yaml:"name"` Value interface{} `field:"required" json:"value" yaml:"value"` }
type VariableGroup ¶
type VariableGroup interface { alicloudroscdkcore.Resource IVariableGroup // Attribute VariableGroupId: Variable group id. AttrVariableGroupId() 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.IResourceEnvironment 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() *VariableGroupProps 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::DEVOPS::VariableGroup`, which is used to create a variable group.
func NewVariableGroup ¶
func NewVariableGroup(scope alicloudroscdkcore.Construct, id *string, props *VariableGroupProps, enableResourcePropertyConstraint *bool) VariableGroup
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type VariableGroupProps ¶
type VariableGroupProps struct { // Property name: The name of variable group. Name interface{} `field:"required" json:"name" yaml:"name"` // Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. OrganizationId interface{} `field:"required" json:"organizationId" yaml:"organizationId"` // Property variables: Variables information. Variables interface{} `field:"required" json:"variables" yaml:"variables"` // Property description: The description of variable group. Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `VariableGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-variablegroup
Source Files
¶
- HostGroup.go
- HostGroupProps.go
- HostGroup__checks.go
- IHostGroup.go
- IPipeline.go
- IPipelineRelations.go
- IPipelineRun.go
- IVariableGroup.go
- Pipeline.go
- PipelineProps.go
- PipelineRelations.go
- PipelineRelationsProps.go
- PipelineRelations__checks.go
- PipelineRun.go
- PipelineRunProps.go
- PipelineRun__checks.go
- Pipeline__checks.go
- RosHostGroup.go
- RosHostGroupProps.go
- RosHostGroup_MachineInfosProperty.go
- RosHostGroup__checks.go
- RosPipeline.go
- RosPipelineProps.go
- RosPipelineRelations.go
- RosPipelineRelationsProps.go
- RosPipelineRelations__checks.go
- RosPipelineRun.go
- RosPipelineRunProps.go
- RosPipelineRun__checks.go
- RosPipeline__checks.go
- RosVariableGroup.go
- RosVariableGroupProps.go
- RosVariableGroup_VariablesProperty.go
- RosVariableGroup__checks.go
- VariableGroup.go
- VariableGroupProps.go
- VariableGroup__checks.go
- main.go