alicloudroscdkcomputenest

package module
v1.6.0 Latest Latest
Warning

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

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

README

Aliyun ROS COMPUTENEST Construct Library

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

import * as COMPUTENEST from '@alicloud/ros-cdk-computenest';

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IntranetConnectorEndpoint_IsConstruct 

func IntranetConnectorEndpoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewIntranetConnectorEndpoint_Override 

func NewIntranetConnectorEndpoint_Override(i IntranetConnectorEndpoint, scope alicloudroscdkcore.Construct, id *string, props *IntranetConnectorEndpointProps, enableResourcePropertyConstraint *bool)

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

func NewRosIntranetConnectorEndpoint_Override 

func NewRosIntranetConnectorEndpoint_Override(r RosIntranetConnectorEndpoint, scope alicloudroscdkcore.Construct, id *string, props *RosIntranetConnectorEndpointProps, enableResourcePropertyConstraint *bool)

func NewRosServiceInstance_Override 

func NewRosServiceInstance_Override(r RosServiceInstance, scope alicloudroscdkcore.Construct, id *string, props *RosServiceInstanceProps, enableResourcePropertyConstraint *bool)

func NewServiceInstance_Override 

func NewServiceInstance_Override(s ServiceInstance, scope alicloudroscdkcore.Construct, id *string, props *ServiceInstanceProps, enableResourcePropertyConstraint *bool)

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

func RosIntranetConnectorEndpoint_IsConstruct 

func RosIntranetConnectorEndpoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosIntranetConnectorEndpoint_IsRosElement 

func RosIntranetConnectorEndpoint_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 RosIntranetConnectorEndpoint_IsRosResource 

func RosIntranetConnectorEndpoint_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosIntranetConnectorEndpoint_ROS_RESOURCE_TYPE_NAME 

func RosIntranetConnectorEndpoint_ROS_RESOURCE_TYPE_NAME() *string

func RosServiceInstance_IsConstruct 

func RosServiceInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosServiceInstance_IsRosElement 

func RosServiceInstance_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 RosServiceInstance_IsRosResource 

func RosServiceInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosServiceInstance_ROS_RESOURCE_TYPE_NAME 

func RosServiceInstance_ROS_RESOURCE_TYPE_NAME() *string

func ServiceInstance_IsConstruct 

func ServiceInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type IIntranetConnectorEndpoint added in v1.6.0 

type IIntranetConnectorEndpoint interface {
	alicloudroscdkcore.IResource
	// Attribute EndpointId: The ID of the endpoint.
	AttrEndpointId() interface{}
	Props() *IntranetConnectorEndpointProps
}

Represents a `IntranetConnectorEndpoint`.

type IServiceInstance added in v1.6.0 

type IServiceInstance interface {
	alicloudroscdkcore.IResource
	// Attribute Components: Additional billing items.
	AttrComponents() interface{}
	// Attribute CreateTime: Creation time.
	AttrCreateTime() interface{}
	// Attribute EnableInstanceOps: Whether the service instance has the O & M function.
	AttrEnableInstanceOps() interface{}
	// Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
	AttrEnableUserPrometheus() interface{}
	// Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
	AttrIsOperated() interface{}
	// Attribute LicenseEndTime: License expiration time.
	AttrLicenseEndTime() interface{}
	// Attribute Name: The name of the service instance.
	AttrName() interface{}
	// Attribute NetworkConfig: Network configuration information.
	AttrNetworkConfig() interface{}
	// Attribute Outputs: Create the output Field returned by the service instance.
	AttrOutputs() interface{}
	// Attribute Parameters: The parameters entered by the deployment service instance.
	AttrParameters() interface{}
	// Attribute PredefinedParameterName: Package name.
	AttrPredefinedParameterName() interface{}
	// Attribute Progress: The deployment progress of the service instance.
	//
	// Unit:%.
	AttrProgress() interface{}
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() interface{}
	// Attribute Service: Service details.
	AttrService() interface{}
	// Attribute ServiceInstanceId: The ID of the service instance.
	AttrServiceInstanceId() interface{}
	// Attribute ServiceType: Service type.
	AttrServiceType() interface{}
	// Attribute Source: The source of the service instance.
	AttrSource() interface{}
	// Attribute StatusDetail: The status description of the deployment instance.
	AttrStatusDetail() interface{}
	// Attribute SupplierUid: Service provider AliUid.
	AttrSupplierUid() interface{}
	// Attribute Tags: User-defined labels.
	AttrTags() interface{}
	// Attribute TemplateName: Template name.
	AttrTemplateName() interface{}
	// Attribute UpdateTime: Update time.
	AttrUpdateTime() interface{}
	// Attribute UserId: AliUid of the user.
	AttrUserId() interface{}
	Props() *ServiceInstanceProps
}

Represents a `ServiceInstance`.

type IntranetConnectorEndpoint 

type IntranetConnectorEndpoint interface {
	alicloudroscdkcore.Resource
	IIntranetConnectorEndpoint
	// Attribute EndpointId: The ID of the endpoint.
	AttrEndpointId() 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() *IntranetConnectorEndpointProps
	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::ComputeNest::IntranetConnectorEndpoint`, which is used to create an endpoint.

func NewIntranetConnectorEndpoint 

func NewIntranetConnectorEndpoint(scope alicloudroscdkcore.Construct, id *string, props *IntranetConnectorEndpointProps, enableResourcePropertyConstraint *bool) IntranetConnectorEndpoint

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

type IntranetConnectorEndpointProps 

type IntranetConnectorEndpointProps struct {
	// Property endpointRegionId: The region ID of the endpoint.
	EndpointRegionId interface{} `field:"required" json:"endpointRegionId" yaml:"endpointRegionId"`
	// Property vpcId: The ID of the VPC to which the endpoint belongs.
	VpcId interface{} `field:"required" json:"vpcId" yaml:"vpcId"`
	// Property description: The description of the endpoint, supporting full character set.
	//
	// The length must not exceed 500 characters.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property enablePrivateZone: Whether to enable the private zone.
	//
	// This parameter is only valid when the access point type is Managed.
	EnablePrivateZone interface{} `field:"optional" json:"enablePrivateZone" yaml:"enablePrivateZone"`
	// Property name: The name of the endpoint, supporting full character set except space.
	//
	// The length must not exceed 200 characters. If not, it will be filled in with EndpointId automatically.
	Name interface{} `field:"optional" json:"name" yaml:"name"`
	// Property resourceIds: Endpoint instance ID, when using ECS as an access point, fill in the instance ID of this ECS.
	//
	// Multiple instances can be specified up to a maximum of 2. The instance is required to be under the passed VPC.
	// Hosted access points do not require incoming.
	ResourceIds interface{} `field:"optional" json:"resourceIds" yaml:"resourceIds"`
	// Property type: The type of the endpoint.
	//
	// - Private (default) : private access point
	// - Managed: managed access point.
	Type interface{} `field:"optional" json:"type" yaml:"type"`
}

Properties for defining a `IntranetConnectorEndpoint`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-computenest-intranetconnectorendpoint

type RosIntranetConnectorEndpoint 

type RosIntranetConnectorEndpoint interface {
	alicloudroscdkcore.RosResource
	AttrEndpointId() 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{})
	EnablePrivateZone() interface{}
	SetEnablePrivateZone(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	EndpointRegionId() interface{}
	SetEndpointRegionId(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
	Name() interface{}
	SetName(val interface{})
	// 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
	ResourceIds() interface{}
	SetResourceIds(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
	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{}
	VpcId() interface{}
	SetVpcId(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::ComputeNest::IntranetConnectorEndpoint`, which is used to create an endpoint.

func NewRosIntranetConnectorEndpoint 

func NewRosIntranetConnectorEndpoint(scope alicloudroscdkcore.Construct, id *string, props *RosIntranetConnectorEndpointProps, enableResourcePropertyConstraint *bool) RosIntranetConnectorEndpoint

type RosIntranetConnectorEndpointProps 

type RosIntranetConnectorEndpointProps struct {
	EndpointRegionId  interface{} `field:"required" json:"endpointRegionId" yaml:"endpointRegionId"`
	VpcId             interface{} `field:"required" json:"vpcId" yaml:"vpcId"`
	Description       interface{} `field:"optional" json:"description" yaml:"description"`
	EnablePrivateZone interface{} `field:"optional" json:"enablePrivateZone" yaml:"enablePrivateZone"`
	Name              interface{} `field:"optional" json:"name" yaml:"name"`
	ResourceIds       interface{} `field:"optional" json:"resourceIds" yaml:"resourceIds"`
	Type              interface{} `field:"optional" json:"type" yaml:"type"`
}

Properties for defining a `RosIntranetConnectorEndpoint`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-computenest-intranetconnectorendpoint

type RosServiceInstance 

type RosServiceInstance interface {
	alicloudroscdkcore.RosResource
	AttrComponents() alicloudroscdkcore.IResolvable
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrEnableInstanceOps() alicloudroscdkcore.IResolvable
	AttrEnableUserPrometheus() alicloudroscdkcore.IResolvable
	AttrIsOperated() alicloudroscdkcore.IResolvable
	AttrLicenseEndTime() alicloudroscdkcore.IResolvable
	AttrName() alicloudroscdkcore.IResolvable
	AttrNetworkConfig() alicloudroscdkcore.IResolvable
	AttrOutputs() alicloudroscdkcore.IResolvable
	AttrParameters() alicloudroscdkcore.IResolvable
	AttrPredefinedParameterName() alicloudroscdkcore.IResolvable
	AttrProgress() alicloudroscdkcore.IResolvable
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	AttrService() alicloudroscdkcore.IResolvable
	AttrServiceInstanceId() alicloudroscdkcore.IResolvable
	AttrServiceType() alicloudroscdkcore.IResolvable
	AttrSource() alicloudroscdkcore.IResolvable
	AttrStatusDetail() alicloudroscdkcore.IResolvable
	AttrSupplierUid() alicloudroscdkcore.IResolvable
	AttrTags() alicloudroscdkcore.IResolvable
	AttrTemplateName() alicloudroscdkcore.IResolvable
	AttrUpdateTime() alicloudroscdkcore.IResolvable
	AttrUserId() alicloudroscdkcore.IResolvable
	Commodity() interface{}
	SetCommodity(val interface{})
	ContactGroup() interface{}
	SetContactGroup(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
	EnableInstanceOps() interface{}
	SetEnableInstanceOps(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	EnableUserPrometheus() interface{}
	SetEnableUserPrometheus(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
	MarketInstanceId() interface{}
	SetMarketInstanceId(val interface{})
	Name() interface{}
	SetName(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	OperationName() interface{}
	SetOperationName(val interface{})
	Parameters() interface{}
	SetParameters(val interface{})
	PredefinedParameterName() interface{}
	SetPredefinedParameterName(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
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	Service() interface{}
	SetService(val interface{})
	SpecificationCode() interface{}
	SetSpecificationCode(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosServiceInstance_TagsProperty
	SetTags(val *[]*RosServiceInstance_TagsProperty)
	TemplateName() interface{}
	SetTemplateName(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::ComputeNest::ServiceInstance`, which is used to create and deploy a service instance.

func NewRosServiceInstance 

func NewRosServiceInstance(scope alicloudroscdkcore.Construct, id *string, props *RosServiceInstanceProps, enableResourcePropertyConstraint *bool) RosServiceInstance

type RosServiceInstanceProps 

type RosServiceInstanceProps struct {
	Service                 interface{}                         `field:"required" json:"service" yaml:"service"`
	Commodity               interface{}                         `field:"optional" json:"commodity" yaml:"commodity"`
	ContactGroup            interface{}                         `field:"optional" json:"contactGroup" yaml:"contactGroup"`
	EnableInstanceOps       interface{}                         `field:"optional" json:"enableInstanceOps" yaml:"enableInstanceOps"`
	EnableUserPrometheus    interface{}                         `field:"optional" json:"enableUserPrometheus" yaml:"enableUserPrometheus"`
	MarketInstanceId        interface{}                         `field:"optional" json:"marketInstanceId" yaml:"marketInstanceId"`
	Name                    interface{}                         `field:"optional" json:"name" yaml:"name"`
	OperationName           interface{}                         `field:"optional" json:"operationName" yaml:"operationName"`
	Parameters              interface{}                         `field:"optional" json:"parameters" yaml:"parameters"`
	PredefinedParameterName interface{}                         `field:"optional" json:"predefinedParameterName" yaml:"predefinedParameterName"`
	ResourceGroupId         interface{}                         `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	SpecificationCode       interface{}                         `field:"optional" json:"specificationCode" yaml:"specificationCode"`
	Tags                    *[]*RosServiceInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	TemplateName            interface{}                         `field:"optional" json:"templateName" yaml:"templateName"`
}

Properties for defining a `RosServiceInstance`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-computenest-serviceinstance

type RosServiceInstance_CommodityProperty 

type RosServiceInstance_CommodityProperty struct {
	PayPeriod     interface{} `field:"optional" json:"payPeriod" yaml:"payPeriod"`
	PayPeriodUnit interface{} `field:"optional" json:"payPeriodUnit" yaml:"payPeriodUnit"`
}

type RosServiceInstance_ServiceProperty 

type RosServiceInstance_ServiceProperty struct {
	ServiceId interface{} `field:"required" json:"serviceId" yaml:"serviceId"`
	Version   interface{} `field:"optional" json:"version" yaml:"version"`
}

type RosServiceInstance_TagsProperty 

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

type ServiceInstance 

type ServiceInstance interface {
	alicloudroscdkcore.Resource
	IServiceInstance
	// Attribute Components: Additional billing items.
	AttrComponents() interface{}
	// Attribute CreateTime: Creation time.
	AttrCreateTime() interface{}
	// Attribute EnableInstanceOps: Whether the service instance has the O & M function.
	AttrEnableInstanceOps() interface{}
	// Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
	AttrEnableUserPrometheus() interface{}
	// Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
	AttrIsOperated() interface{}
	// Attribute LicenseEndTime: License expiration time.
	AttrLicenseEndTime() interface{}
	// Attribute Name: The name of the service instance.
	AttrName() interface{}
	// Attribute NetworkConfig: Network configuration information.
	AttrNetworkConfig() interface{}
	// Attribute Outputs: Create the output Field returned by the service instance.
	AttrOutputs() interface{}
	// Attribute Parameters: The parameters entered by the deployment service instance.
	AttrParameters() interface{}
	// Attribute PredefinedParameterName: Package name.
	AttrPredefinedParameterName() interface{}
	// Attribute Progress: The deployment progress of the service instance.
	//
	// Unit:%.
	AttrProgress() interface{}
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() interface{}
	// Attribute Service: Service details.
	AttrService() interface{}
	// Attribute ServiceInstanceId: The ID of the service instance.
	AttrServiceInstanceId() interface{}
	// Attribute ServiceType: Service type.
	AttrServiceType() interface{}
	// Attribute Source: The source of the service instance.
	AttrSource() interface{}
	// Attribute StatusDetail: The status description of the deployment instance.
	AttrStatusDetail() interface{}
	// Attribute SupplierUid: Service provider AliUid.
	AttrSupplierUid() interface{}
	// Attribute Tags: User-defined labels.
	AttrTags() interface{}
	// Attribute TemplateName: Template name.
	AttrTemplateName() interface{}
	// Attribute UpdateTime: Update time.
	AttrUpdateTime() interface{}
	// Attribute UserId: AliUid of the user.
	AttrUserId() 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() *ServiceInstanceProps
	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::ComputeNest::ServiceInstance`, which is used to create and deploy a service instance.

func NewServiceInstance 

func NewServiceInstance(scope alicloudroscdkcore.Construct, id *string, props *ServiceInstanceProps, enableResourcePropertyConstraint *bool) ServiceInstance

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

type ServiceInstanceProps 

type ServiceInstanceProps struct {
	// Property service: Service details.
	Service interface{} `field:"required" json:"service" yaml:"service"`
	// Property commodity: Cloud market commodity purchase parameters.
	Commodity interface{} `field:"optional" json:"commodity" yaml:"commodity"`
	// Property contactGroup: Alarm Contact Group.
	ContactGroup interface{} `field:"optional" json:"contactGroup" yaml:"contactGroup"`
	// Property enableInstanceOps: Whether the service instance has the O & M function.
	//
	// Possible values:
	// - true: The service instance has a generation O & M function.
	// - false: The service instance does not have the O & M function.
	EnableInstanceOps interface{} `field:"optional" json:"enableInstanceOps" yaml:"enableInstanceOps"`
	// Property enableUserPrometheus: Whether Prometheus monitoring is enabled.
	//
	// Possible values:
	// - true: enabled.
	// - false: not enabled.
	EnableUserPrometheus interface{} `field:"optional" json:"enableUserPrometheus" yaml:"enableUserPrometheus"`
	// Property marketInstanceId: The ID of the cloud marketplace instance.
	MarketInstanceId interface{} `field:"optional" json:"marketInstanceId" yaml:"marketInstanceId"`
	// Property name: The name of the service instance.
	Name interface{} `field:"optional" json:"name" yaml:"name"`
	// Property operationName: Change operation name.
	OperationName interface{} `field:"optional" json:"operationName" yaml:"operationName"`
	// Property parameters: The parameters entered by the deployment service instance.
	Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
	// Property predefinedParameterName: Package name.
	PredefinedParameterName interface{} `field:"optional" json:"predefinedParameterName" yaml:"predefinedParameterName"`
	// Property resourceGroupId: The ID of the resource group.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	// Property specificationCode: Commodity specification Code.
	SpecificationCode interface{} `field:"optional" json:"specificationCode" yaml:"specificationCode"`
	// Property tags: Tags of service instance.
	Tags *[]*RosServiceInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	// Property templateName: Template name.
	TemplateName interface{} `field:"optional" json:"templateName" yaml:"templateName"`
}

Properties for defining a `ServiceInstance`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-computenest-serviceinstance

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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