Documentation ¶
Index ¶
- func Apis_IsConstruct(x interface{}) *bool
- func Apps_IsConstruct(x interface{}) *bool
- func Groups_IsConstruct(x interface{}) *bool
- func Instance_IsConstruct(x interface{}) *bool
- func Instances_IsConstruct(x interface{}) *bool
- func NewApis_Override(a Apis, scope alicloudroscdkcore.Construct, id *string, props *ApisProps, ...)
- func NewApps_Override(a Apps, scope alicloudroscdkcore.Construct, id *string, props *AppsProps, ...)
- func NewGroups_Override(g Groups, scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, ...)
- func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewInstances_Override(i Instances, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosApis_Override(r RosApis, scope alicloudroscdkcore.Construct, id *string, props *RosApisProps, ...)
- func NewRosApps_Override(r RosApps, scope alicloudroscdkcore.Construct, id *string, props *RosAppsProps, ...)
- func NewRosGroups_Override(r RosGroups, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosInstances_Override(r RosInstances, scope alicloudroscdkcore.Construct, id *string, ...)
- func RosApis_IsConstruct(x interface{}) *bool
- func RosApis_IsRosElement(x interface{}) *bool
- func RosApis_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosApis_ROS_RESOURCE_TYPE_NAME() *string
- func RosApps_IsConstruct(x interface{}) *bool
- func RosApps_IsRosElement(x interface{}) *bool
- func RosApps_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosApps_ROS_RESOURCE_TYPE_NAME() *string
- func RosGroups_IsConstruct(x interface{}) *bool
- func RosGroups_IsRosElement(x interface{}) *bool
- func RosGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGroups_ROS_RESOURCE_TYPE_NAME() *string
- func RosInstance_IsConstruct(x interface{}) *bool
- func RosInstance_IsRosElement(x interface{}) *bool
- func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosInstance_ROS_RESOURCE_TYPE_NAME() *string
- func RosInstances_IsConstruct(x interface{}) *bool
- func RosInstances_IsRosElement(x interface{}) *bool
- func RosInstances_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosInstances_ROS_RESOURCE_TYPE_NAME() *string
- type Apis
- type ApisProps
- type Apps
- type AppsProps
- type Groups
- type GroupsProps
- type IApis
- type IApps
- type IGroups
- type IInstance
- type IInstances
- type Instance
- type InstanceProps
- type Instances
- type InstancesProps
- type RosApis
- type RosApisProps
- type RosApps
- type RosAppsProps
- type RosGroups
- type RosGroupsProps
- type RosInstance
- type RosInstanceProps
- type RosInstances
- type RosInstancesProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Apis_IsConstruct ¶
func Apis_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Apps_IsConstruct ¶
func Apps_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Groups_IsConstruct ¶
func Groups_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Instance_IsConstruct ¶
func Instance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Instances_IsConstruct ¶
func Instances_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewApis_Override ¶
func NewApis_Override(a Apis, scope alicloudroscdkcore.Construct, id *string, props *ApisProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewApps_Override ¶
func NewApps_Override(a Apps, scope alicloudroscdkcore.Construct, id *string, props *AppsProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewGroups_Override ¶
func NewGroups_Override(g Groups, scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewInstance_Override ¶
func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewInstances_Override ¶
func NewInstances_Override(i Instances, scope alicloudroscdkcore.Construct, id *string, props *InstancesProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosApis_Override ¶
func NewRosApis_Override(r RosApis, scope alicloudroscdkcore.Construct, id *string, props *RosApisProps, enableResourcePropertyConstraint *bool)
func NewRosApps_Override ¶
func NewRosApps_Override(r RosApps, scope alicloudroscdkcore.Construct, id *string, props *RosAppsProps, enableResourcePropertyConstraint *bool)
func NewRosGroups_Override ¶
func NewRosGroups_Override(r RosGroups, scope alicloudroscdkcore.Construct, id *string, props *RosGroupsProps, enableResourcePropertyConstraint *bool)
func NewRosInstance_Override ¶
func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool)
func NewRosInstances_Override ¶
func NewRosInstances_Override(r RosInstances, scope alicloudroscdkcore.Construct, id *string, props *RosInstancesProps, enableResourcePropertyConstraint *bool)
func RosApis_IsConstruct ¶
func RosApis_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApis_IsRosElement ¶
func RosApis_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 RosApis_IsRosResource ¶
func RosApis_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosApis_ROS_RESOURCE_TYPE_NAME ¶
func RosApis_ROS_RESOURCE_TYPE_NAME() *string
func RosApps_IsConstruct ¶
func RosApps_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApps_IsRosElement ¶
func RosApps_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 RosApps_IsRosResource ¶
func RosApps_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosApps_ROS_RESOURCE_TYPE_NAME ¶
func RosApps_ROS_RESOURCE_TYPE_NAME() *string
func RosGroups_IsConstruct ¶
func RosGroups_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGroups_IsRosElement ¶
func RosGroups_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 RosGroups_IsRosResource ¶
func RosGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGroups_ROS_RESOURCE_TYPE_NAME ¶
func RosGroups_ROS_RESOURCE_TYPE_NAME() *string
func RosInstance_IsConstruct ¶
func RosInstance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosInstance_IsRosElement ¶
func RosInstance_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 RosInstance_IsRosResource ¶
func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosInstance_ROS_RESOURCE_TYPE_NAME ¶
func RosInstance_ROS_RESOURCE_TYPE_NAME() *string
func RosInstances_IsConstruct ¶
func RosInstances_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosInstances_IsRosElement ¶
func RosInstances_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 RosInstances_IsRosResource ¶
func RosInstances_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosInstances_ROS_RESOURCE_TYPE_NAME ¶
func RosInstances_ROS_RESOURCE_TYPE_NAME() *string
Types ¶
type Apis ¶
type Apis interface { alicloudroscdkcore.Resource IApis // Attribute ApiIds: The list of The ApiGateway api ids. AttrApiIds() interface{} // Attribute Apis: The information about ApiGateway apis. AttrApis() 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() *ApisProps 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::ApiGateway::Apis`, which is used to query APIs in API Gateway.
type ApisProps ¶
type ApisProps struct { // Property apiId: ID of the specified API. ApiId interface{} `field:"optional" json:"apiId" yaml:"apiId"` // Property apiName: API name (fuzzy matching). ApiName interface{} `field:"optional" json:"apiName" yaml:"apiName"` // Property catalogId: Catalog number. CatalogId interface{} `field:"optional" json:"catalogId" yaml:"catalogId"` // Property enableTagAuth: Enable label validation. EnableTagAuth interface{} `field:"optional" json:"enableTagAuth" yaml:"enableTagAuth"` // Property groupId: ID of the specified group. GroupId interface{} `field:"optional" json:"groupId" yaml:"groupId"` // 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 visibility: Whether the API is public. Visibility interface{} `field:"optional" json:"visibility" yaml:"visibility"` }
Properties for defining a `Apis`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-apis
type Apps ¶
type Apps interface { alicloudroscdkcore.Resource IApps // Attribute AppIds: The list of The ApiGateway app ids. AttrAppIds() interface{} // Attribute Apps: The information about ApiGateway apps. AttrApps() 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() *AppsProps 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::ApiGateway::Apps`, which is used to query applications.
type AppsProps ¶
type AppsProps struct { // Property appId: Unique ID of the app. AppId interface{} `field:"optional" json:"appId" yaml:"appId"` // Property appOwner: Alibaba Cloud account ID of the app owner. AppOwner interface{} `field:"optional" json:"appOwner" yaml:"appOwner"` // 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 `Apps`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-apps
type Groups ¶
type Groups interface { alicloudroscdkcore.Resource IGroups // Attribute ApiGroupIds: The list of The ApiGateway group ids. AttrApiGroupIds() interface{} // Attribute ApiGroups: The information about ApiGateway groups. AttrApiGroups() 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() *GroupsProps 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::ApiGateway::Groups`, which is used to query the information about existing API groups.
func NewGroups ¶
func NewGroups(scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, enableResourcePropertyConstraint *bool) Groups
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GroupsProps ¶
type GroupsProps struct { // Property groupId: API group ID. GroupId interface{} `field:"optional" json:"groupId" yaml:"groupId"` // Property groupName: Specified keyword of the API group name. GroupName interface{} `field:"optional" json:"groupName" yaml:"groupName"` // Property instanceId: API Gateway Instance ID. InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` // 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 sort: Sort. Sort interface{} `field:"optional" json:"sort" yaml:"sort"` }
Properties for defining a `Groups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-groups
type IApis ¶ added in v1.6.0
type IApis interface { alicloudroscdkcore.IResource // Attribute ApiIds: The list of The ApiGateway api ids. AttrApiIds() interface{} // Attribute Apis: The information about ApiGateway apis. AttrApis() interface{} Props() *ApisProps }
Represents a `Apis`.
type IApps ¶ added in v1.6.0
type IApps interface { alicloudroscdkcore.IResource // Attribute AppIds: The list of The ApiGateway app ids. AttrAppIds() interface{} // Attribute Apps: The information about ApiGateway apps. AttrApps() interface{} Props() *AppsProps }
Represents a `Apps`.
type IGroups ¶ added in v1.6.0
type IGroups interface { alicloudroscdkcore.IResource // Attribute ApiGroupIds: The list of The ApiGateway group ids. AttrApiGroupIds() interface{} // Attribute ApiGroups: The information about ApiGateway groups. AttrApiGroups() interface{} Props() *GroupsProps }
Represents a `Groups`.
type IInstance ¶ added in v1.6.0
type IInstance interface { alicloudroscdkcore.IResource // Attribute AclId: Access control ID. AttrAclId() interface{} // Attribute AclName: Access control name. AttrAclName() interface{} // Attribute AclStatus: Access control type. AttrAclStatus() interface{} // Attribute AclType: Access control type. AttrAclType() interface{} // Attribute ClassicEgressAddress: Classic network exit address. AttrClassicEgressAddress() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute EgressIpv6Enable: Does IPV6 Capability Support. AttrEgressIpv6Enable() interface{} // Attribute ExpiredTime: Instance expiration time. AttrExpiredTime() interface{} // Attribute HttpsPolicy: Https policy. AttrHttpsPolicy() interface{} // Attribute InstanceId: Instance id. AttrInstanceId() interface{} // Attribute InstanceName: Instance name. AttrInstanceName() interface{} // Attribute InstanceRpsLimit: Instance rps limits. AttrInstanceRpsLimit() interface{} // Attribute InstanceSpec: Instance type. AttrInstanceSpec() interface{} // Attribute InstanceSpecAttributes: Instance type. AttrInstanceSpecAttributes() interface{} // Attribute InstanceType: Instance type. AttrInstanceType() interface{} // Attribute InternetEgressAddress: Public network exit address. AttrInternetEgressAddress() interface{} // Attribute PaymentType: The payment type of the resource. AttrPaymentType() interface{} // Attribute SupportIpv6: Does ipv6 support. AttrSupportIpv6() interface{} // Attribute UserVpcId: User's VpcID. AttrUserVpcId() interface{} // Attribute UserVswitchId: DescribeInstances. AttrUserVswitchId() interface{} // Attribute VipTypeList: Vip type. AttrVipTypeList() interface{} // Attribute VpcEgressAddress: Intranet VPC exit network segment. AttrVpcEgressAddress() interface{} // Attribute VpcIntranetEnable: Whether Vpc allows authorization. AttrVpcIntranetEnable() interface{} // Attribute VpcOwnerId: Vpc licensor ID. AttrVpcOwnerId() interface{} // Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports. AttrVpcSlbIntranetEnable() interface{} // Attribute ZoneId: Zone. AttrZoneId() interface{} // Attribute ZoneLocalName: Available area. AttrZoneLocalName() interface{} Props() *InstanceProps }
Represents a `Instance`.
type IInstances ¶ added in v1.6.0
type IInstances interface { alicloudroscdkcore.IResource // Attribute ApiGatewayInstanceIds: The list of The ApiGateway group ids. AttrApiGatewayInstanceIds() interface{} // Attribute ApiGatewayInstances: The information about ApiGateway groups. AttrApiGatewayInstances() interface{} Props() *InstancesProps }
Represents a `Instances`.
type Instance ¶
type Instance interface { alicloudroscdkcore.Resource IInstance // Attribute AclId: Access control ID. AttrAclId() interface{} // Attribute AclName: Access control name. AttrAclName() interface{} // Attribute AclStatus: Access control type. AttrAclStatus() interface{} // Attribute AclType: Access control type. AttrAclType() interface{} // Attribute ClassicEgressAddress: Classic network exit address. AttrClassicEgressAddress() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute EgressIpv6Enable: Does IPV6 Capability Support. AttrEgressIpv6Enable() interface{} // Attribute ExpiredTime: Instance expiration time. AttrExpiredTime() interface{} // Attribute HttpsPolicy: Https policy. AttrHttpsPolicy() interface{} // Attribute InstanceId: Instance id. AttrInstanceId() interface{} // Attribute InstanceName: Instance name. AttrInstanceName() interface{} // Attribute InstanceRpsLimit: Instance rps limits. AttrInstanceRpsLimit() interface{} // Attribute InstanceSpec: Instance type. AttrInstanceSpec() interface{} // Attribute InstanceSpecAttributes: Instance type. AttrInstanceSpecAttributes() interface{} // Attribute InstanceType: Instance type. AttrInstanceType() interface{} // Attribute InternetEgressAddress: Public network exit address. AttrInternetEgressAddress() interface{} // Attribute PaymentType: The payment type of the resource. AttrPaymentType() interface{} // Attribute SupportIpv6: Does ipv6 support. AttrSupportIpv6() interface{} // Attribute UserVpcId: User's VpcID. AttrUserVpcId() interface{} // Attribute UserVswitchId: DescribeInstances. AttrUserVswitchId() interface{} // Attribute VipTypeList: Vip type. AttrVipTypeList() interface{} // Attribute VpcEgressAddress: Intranet VPC exit network segment. AttrVpcEgressAddress() interface{} // Attribute VpcIntranetEnable: Whether Vpc allows authorization. AttrVpcIntranetEnable() interface{} // Attribute VpcOwnerId: Vpc licensor ID. AttrVpcOwnerId() interface{} // Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports. AttrVpcSlbIntranetEnable() interface{} // Attribute ZoneId: Zone. AttrZoneId() interface{} // Attribute ZoneLocalName: Available area. AttrZoneLocalName() 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() *InstanceProps 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::ApiGateway::Instance`, which is used to query the information about an instance.
func NewInstance ¶
func NewInstance(scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool) Instance
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type InstanceProps ¶
type InstanceProps struct { // Property instanceId: Instance id. InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // 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 `Instance`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-instance
type Instances ¶
type Instances interface { alicloudroscdkcore.Resource IInstances // Attribute ApiGatewayInstanceIds: The list of The ApiGateway group ids. AttrApiGatewayInstanceIds() interface{} // Attribute ApiGatewayInstances: The information about ApiGateway groups. AttrApiGatewayInstances() 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() *InstancesProps 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::ApiGateway::Instances`, which is used to query instances.
func NewInstances ¶
func NewInstances(scope alicloudroscdkcore.Construct, id *string, props *InstancesProps, enableResourcePropertyConstraint *bool) Instances
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type InstancesProps ¶
type InstancesProps struct { // Property instanceId: API Gateway Instance ID. InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` // Property language: Language Type. Language interface{} `field:"optional" json:"language" yaml:"language"` // 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 `Instances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-instances
type RosApis ¶
type RosApis interface { alicloudroscdkcore.RosResource ApiId() interface{} SetApiId(val interface{}) ApiName() interface{} SetApiName(val interface{}) AttrApiIds() alicloudroscdkcore.IResolvable AttrApis() alicloudroscdkcore.IResolvable CatalogId() interface{} SetCatalogId(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) EnableTagAuth() interface{} SetEnableTagAuth(val interface{}) GroupId() interface{} SetGroupId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // 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{} Visibility() interface{} SetVisibility(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::ApiGateway::Apis`, which is used to query APIs in API Gateway.
func NewRosApis ¶
func NewRosApis(scope alicloudroscdkcore.Construct, id *string, props *RosApisProps, enableResourcePropertyConstraint *bool) RosApis
type RosApisProps ¶
type RosApisProps struct { ApiId interface{} `field:"optional" json:"apiId" yaml:"apiId"` ApiName interface{} `field:"optional" json:"apiName" yaml:"apiName"` CatalogId interface{} `field:"optional" json:"catalogId" yaml:"catalogId"` EnableTagAuth interface{} `field:"optional" json:"enableTagAuth" yaml:"enableTagAuth"` GroupId interface{} `field:"optional" json:"groupId" yaml:"groupId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` Visibility interface{} `field:"optional" json:"visibility" yaml:"visibility"` }
Properties for defining a `RosApis`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-apis
type RosApps ¶
type RosApps interface { alicloudroscdkcore.RosResource AppId() interface{} SetAppId(val interface{}) AppOwner() interface{} SetAppOwner(val interface{}) AttrAppIds() alicloudroscdkcore.IResolvable AttrApps() 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{} 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::ApiGateway::Apps`, which is used to query applications.
func NewRosApps ¶
func NewRosApps(scope alicloudroscdkcore.Construct, id *string, props *RosAppsProps, enableResourcePropertyConstraint *bool) RosApps
type RosAppsProps ¶
type RosAppsProps struct { AppId interface{} `field:"optional" json:"appId" yaml:"appId"` AppOwner interface{} `field:"optional" json:"appOwner" yaml:"appOwner"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosApps`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-apps
type RosGroups ¶
type RosGroups interface { alicloudroscdkcore.RosResource AttrApiGroupIds() alicloudroscdkcore.IResolvable AttrApiGroups() 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) GroupId() interface{} SetGroupId(val interface{}) GroupName() interface{} SetGroupName(val interface{}) InstanceId() interface{} SetInstanceId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // 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 Sort() interface{} SetSort(val interface{}) // 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 `DATASOURCE::ApiGateway::Groups`, which is used to query the information about existing API groups.
func NewRosGroups ¶
func NewRosGroups(scope alicloudroscdkcore.Construct, id *string, props *RosGroupsProps, enableResourcePropertyConstraint *bool) RosGroups
type RosGroupsProps ¶
type RosGroupsProps struct { GroupId interface{} `field:"optional" json:"groupId" yaml:"groupId"` GroupName interface{} `field:"optional" json:"groupName" yaml:"groupName"` InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` Sort interface{} `field:"optional" json:"sort" yaml:"sort"` }
Properties for defining a `RosGroups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-groups
type RosInstance ¶
type RosInstance interface { alicloudroscdkcore.RosResource AttrAclId() alicloudroscdkcore.IResolvable AttrAclName() alicloudroscdkcore.IResolvable AttrAclStatus() alicloudroscdkcore.IResolvable AttrAclType() alicloudroscdkcore.IResolvable AttrClassicEgressAddress() alicloudroscdkcore.IResolvable AttrCreateTime() alicloudroscdkcore.IResolvable AttrEgressIpv6Enable() alicloudroscdkcore.IResolvable AttrExpiredTime() alicloudroscdkcore.IResolvable AttrHttpsPolicy() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrInstanceName() alicloudroscdkcore.IResolvable AttrInstanceRpsLimit() alicloudroscdkcore.IResolvable AttrInstanceSpec() alicloudroscdkcore.IResolvable AttrInstanceSpecAttributes() alicloudroscdkcore.IResolvable AttrInstanceType() alicloudroscdkcore.IResolvable AttrInternetEgressAddress() alicloudroscdkcore.IResolvable AttrPaymentType() alicloudroscdkcore.IResolvable AttrSupportIpv6() alicloudroscdkcore.IResolvable AttrUserVpcId() alicloudroscdkcore.IResolvable AttrUserVswitchId() alicloudroscdkcore.IResolvable AttrVipTypeList() alicloudroscdkcore.IResolvable AttrVpcEgressAddress() alicloudroscdkcore.IResolvable AttrVpcIntranetEnable() alicloudroscdkcore.IResolvable AttrVpcOwnerId() alicloudroscdkcore.IResolvable AttrVpcSlbIntranetEnable() alicloudroscdkcore.IResolvable AttrZoneId() alicloudroscdkcore.IResolvable AttrZoneLocalName() 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) InstanceId() interface{} SetInstanceId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // 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{} 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::ApiGateway::Instance`, which is used to query the information about an instance.
func NewRosInstance ¶
func NewRosInstance(scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool) RosInstance
type RosInstanceProps ¶
type RosInstanceProps struct { InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosInstance`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-instance
type RosInstances ¶
type RosInstances interface { alicloudroscdkcore.RosResource AttrApiGatewayInstanceIds() alicloudroscdkcore.IResolvable AttrApiGatewayInstances() 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) InstanceId() interface{} SetInstanceId(val interface{}) Language() interface{} SetLanguage(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // 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{} 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::ApiGateway::Instances`, which is used to query instances.
func NewRosInstances ¶
func NewRosInstances(scope alicloudroscdkcore.Construct, id *string, props *RosInstancesProps, enableResourcePropertyConstraint *bool) RosInstances
type RosInstancesProps ¶
type RosInstancesProps struct { InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` Language interface{} `field:"optional" json:"language" yaml:"language"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosInstances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-instances
Source Files ¶
- Apis.go
- ApisProps.go
- Apis__checks.go
- Apps.go
- AppsProps.go
- Apps__checks.go
- Groups.go
- GroupsProps.go
- Groups__checks.go
- IApis.go
- IApps.go
- IGroups.go
- IInstance.go
- IInstances.go
- Instance.go
- InstanceProps.go
- Instance__checks.go
- Instances.go
- InstancesProps.go
- Instances__checks.go
- RosApis.go
- RosApisProps.go
- RosApis__checks.go
- RosApps.go
- RosAppsProps.go
- RosApps__checks.go
- RosGroups.go
- RosGroupsProps.go
- RosGroups__checks.go
- RosInstance.go
- RosInstanceProps.go
- RosInstance__checks.go
- RosInstances.go
- RosInstancesProps.go
- RosInstances__checks.go
- main.go