RosDeployment

This class is a base encapsulation around the ROS resource type ALIYUN::ApiGateway::Deployment, which is used to publish an API to a specific runtime environment, or switch a published API to a specific version.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapigateway"
alicloudroscdkapigateway.NewRosDeployment(scope Construct, id *string, props RosDeploymentProps, enableResourcePropertyConstraint *bool) RosDeployment

Name	Type	Description
scope	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct	- scope in which this resource is defined.
id	*string	- scoped id of the resource.
props	RosDeploymentProps	- resource properties.
enableResourcePropertyConstraint	*bool	No description.

---

scope^Required

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

scope in which this resource is defined.

---

id^Required

• Type: *string

scoped id of the resource.

---

props^Required

• Type: RosDeploymentProps

resource properties.

---

enableResourcePropertyConstraint^Required

• Type: *bool

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
Synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
AddCondition	No description.
AddCount	No description.
AddDeletionOverride	Syntactic sugar for addOverride(path, undefined).
AddDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc	No description.
AddMetaData	No description.
AddOverride	Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride	Adds an override to a resource property.
AddRosDependency	No description.
ApplyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
GetAtt	Returns a token for an runtime attribute of this resource.

---

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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

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

session^Required

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

The synthesis session.

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: *string

The new logical ID to use for this stack element.

---

AddCondition

func AddCondition(con RosCondition)

con^Required

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

---

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

---

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: *string

The path of the value to delete.

---

AddDependsOn

func AddDependsOn(target RosResource)

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.

target^Required

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

---

AddDesc

func AddDesc(desc *string)

desc^Required

• Type: *string

---

AddMetaData

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

key^Required

• Type: *string

---

value^Required

• Type: interface{}

---

AddOverride

func AddOverride(path *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,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: *string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

value^Required

• Type: interface{}

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: *string

The path to the property.

---

AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: *string

The path of the property.

---

value^Required

• Type: interface{}

The value.

---

AddRosDependency

func AddRosDependency(target *string)

target^Required

• Type: *string

---

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

---

options^Optional

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

---

GetAtt

func GetAtt(attributeName *string) Reference

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.

attributeName^Required

• Type: *string

The name of the attribute.

---

Static Functions

Name	Description
IsConstruct	Return whether the given object is a Construct.
IsRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource	Check whether the given construct is a RosResource.

---

IsConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: interface{}

---

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapigateway"
alicloudroscdkapigateway.RosDeployment_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.

x^Required

• Type: interface{}

---

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapigateway"
alicloudroscdkapigateway.RosDeployment_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

construct^Required

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

---

Properties

Name	Type	Description
Node	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode	The construct tree node associated with this construct.
CreationStack	[]string	No description.
LogicalId	*string	The logical ID for this stack element.
Stack	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack	The stack in which this element is defined.
Ref	*string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	*string	ROS resource type.
ApiId	interface{}	No description.
EnableResourcePropertyConstraint	*bool	No description.
GroupId	interface{}	No description.
StageName	interface{}	No description.
Description	interface{}	No description.
HistoryVersion	interface{}	No description.

---

Node^Required

func Node() ConstructNode

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

The construct tree node associated with this construct.

---

CreationStack^Required

func CreationStack() *[]*string

• Type: []string

---

LogicalId^Required

func LogicalId() *string

• Type: *string

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).

---

Stack^Required

func Stack() Stack

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

Ref^Required

func Ref() *string

• Type: *string

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 }).

---

RosOptions^Required

func RosOptions() IRosResourceOptions

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

Options for this resource, such as condition, update policy etc.

---

RosResourceType^Required

func RosResourceType() *string

• Type: *string

ROS resource type.

---

ApiId^Required

func ApiId() interface{}

• Type: interface{}

---

EnableResourcePropertyConstraint^Required

func EnableResourcePropertyConstraint() *bool

• Type: *bool

---

GroupId^Required

func GroupId() interface{}

• Type: interface{}

---

StageName^Required

func StageName() interface{}

• Type: interface{}

---

Description^Optional

func Description() interface{}

• Type: interface{}

---

HistoryVersion^Optional

func HistoryVersion() interface{}

• Type: interface{}

---

Constants

Name	Type	Description
RosResourceTypeName	*string	The resource type name for this resource class.

---

RosResourceTypeName^Required

func RosResourceTypeName() *string

• Type: *string

The resource type name for this resource class.

---