Skip to content

RosInstanceGroup

This class is a base encapsulation around the ROS resource type ALIYUN::ECS::InstanceGroup, which is used to create Elastic Compute Service (ECS) instances that have the same configurations.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs"
alicloudroscdkecs.NewRosInstanceGroup(scope Construct, id *string, props RosInstanceGroupProps, enableResourcePropertyConstraint *bool) RosInstanceGroup
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct - scope in which this resource is defined.
id *string - scoped id of the resource.
props RosInstanceGroupProps - resource properties.
enableResourcePropertyConstraint *bool No description.

scopeRequired

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

scope in which this resource is defined.


idRequired

  • Type: *string

scoped id of the resource.


propsRequired

resource properties.


enableResourcePropertyConstraintRequired

  • Type: *bool

Methods

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

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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

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

sessionRequired

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

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


AddCondition

func AddCondition(con RosCondition)

conRequired

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

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: *string

The path of the value to delete.


AddDependsOn

func AddDependsOn(target RosResource)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

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

AddDesc

func AddDesc(desc *string)

descRequired

  • Type: *string

AddMetaData

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

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

AddOverride

func AddOverride(path *string, value interface{})

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

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

would add the overrides

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

pathRequired

  • Type: *string

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

Any intermdediate keys will be created as needed.


valueRequired

  • Type: interface{}

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

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

propertyPathRequired

  • Type: *string

The path to the property.


AddPropertyOverride

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

Adds an override to a resource property.

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

propertyPathRequired

  • Type: *string

The path of the property.


valueRequired

  • Type: interface{}

The value.


AddRosDependency

func AddRosDependency(target *string)

targetRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

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

policyOptional

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

optionsOptional

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

GetAtt

func GetAtt(attributeName *string) Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: *string

The name of the attribute.


Static Functions

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

IsConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

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

xRequired

  • Type: interface{}

IsRosResource

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

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
CreationStack []string No description.
LogicalId *string The logical ID for this stack element.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this element is defined.
Ref *string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType *string ROS resource type.
AttrHostNames github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInnerIps github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInstanceIds github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIpv6Addresses github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIpv6AddressIds github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrOrderId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPrivateIps github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPublicIps github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrRelatedOrderIds github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrZoneIds github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
EnableResourcePropertyConstraint *bool No description.
InstanceType interface{} No description.
MaxAmount interface{} No description.
Affinity interface{} No description.
AllocatePublicIp interface{} No description.
AutoReleaseTime interface{} No description.
AutoRenew interface{} No description.
AutoRenewPeriod interface{} No description.
CpuOptions interface{} No description.
CreditSpecification interface{} No description.
DedicatedHostId interface{} No description.
DeletionForce interface{} No description.
DeletionProtection interface{} No description.
DeploymentSetGroupNo interface{} No description.
DeploymentSetId interface{} No description.
Description interface{} No description.
DiskMappings interface{} No description.
EniMappings interface{} No description.
HostName interface{} No description.
HostNames interface{} No description.
HpcClusterId interface{} No description.
HttpEndpoint interface{} No description.
HttpTokens interface{} No description.
ImageFamily interface{} No description.
ImageId interface{} No description.
ImageOptions interface{} No description.
InstanceChargeType interface{} No description.
InstanceName interface{} No description.
InternetChargeType interface{} No description.
InternetMaxBandwidthOut interface{} No description.
IoOptimized interface{} No description.
Ipv6AddressCount interface{} No description.
Ipv6Addresses interface{} No description.
KeyPairName interface{} No description.
LaunchTemplateId interface{} No description.
LaunchTemplateName interface{} No description.
LaunchTemplateVersion interface{} No description.
NetworkInterfaceQueueNumber interface{} No description.
NetworkOptions interface{} No description.
NetworkType interface{} No description.
Password interface{} No description.
PasswordInherit interface{} No description.
Period interface{} No description.
PeriodUnit interface{} No description.
PrivateIpAddress interface{} No description.
PrivatePoolOptions interface{} No description.
RamRoleName interface{} No description.
ResourceGroupId interface{} No description.
SchedulerOptions interface{} No description.
SecurityEnhancementStrategy interface{} No description.
SecurityGroupId interface{} No description.
SecurityGroupIds interface{} No description.
SecurityOptions interface{} No description.
SpotDuration interface{} No description.
SpotInterruptionBehavior interface{} No description.
SpotPriceLimit interface{} No description.
SpotStrategy interface{} No description.
StorageSetId interface{} No description.
StorageSetPartitionNumber interface{} No description.
SystemDiskAutoSnapshotPolicyId interface{} No description.
SystemDiskBurstingEnabled interface{} No description.
SystemDiskCategory interface{} No description.
SystemDiskDescription interface{} No description.
SystemDiskDiskName interface{} No description.
SystemDiskEncryptAlgorithm interface{} No description.
SystemDiskEncrypted interface{} No description.
SystemDiskKmsKeyId interface{} No description.
SystemDiskPerformanceLevel interface{} No description.
SystemDiskProvisionedIops interface{} No description.
SystemDiskSize interface{} No description.
SystemDiskStorageClusterId interface{} No description.
Tags *[]TagsProperty No description.
Tenancy interface{} No description.
UniqueSuffix interface{} No description.
UpdatePolicy interface{} No description.
UseAdditionalService interface{} No description.
UserData interface{} No description.
VpcId interface{} No description.
VSwitchId interface{} No description.
ZoneId interface{} No description.
ZoneIds interface{} No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func LogicalId() *string
  • Type: *string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


StackRequired

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

The stack in which this element is defined.

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


RefRequired

func Ref() *string
  • Type: *string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


RosOptionsRequired

func RosOptions() IRosResourceOptions
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

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


RosResourceTypeRequired

func RosResourceType() *string
  • Type: *string

ROS resource type.


AttrHostNamesRequired

func AttrHostNames() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInnerIpsRequired

func AttrInnerIps() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInstanceIdsRequired

func AttrInstanceIds() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIpv6AddressesRequired

func AttrIpv6Addresses() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIpv6AddressIdsRequired

func AttrIpv6AddressIds() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrOrderIdRequired

func AttrOrderId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPrivateIpsRequired

func AttrPrivateIps() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPublicIpsRequired

func AttrPublicIps() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrRelatedOrderIdsRequired

func AttrRelatedOrderIds() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrZoneIdsRequired

func AttrZoneIds() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

InstanceTypeRequired

func InstanceType() interface{}
  • Type: interface{}

MaxAmountRequired

func MaxAmount() interface{}
  • Type: interface{}

AffinityOptional

func Affinity() interface{}
  • Type: interface{}

AllocatePublicIpOptional

func AllocatePublicIp() interface{}
  • Type: interface{}

AutoReleaseTimeOptional

func AutoReleaseTime() interface{}
  • Type: interface{}

AutoRenewOptional

func AutoRenew() interface{}
  • Type: interface{}

AutoRenewPeriodOptional

func AutoRenewPeriod() interface{}
  • Type: interface{}

CpuOptionsOptional

func CpuOptions() interface{}
  • Type: interface{}

CreditSpecificationOptional

func CreditSpecification() interface{}
  • Type: interface{}

DedicatedHostIdOptional

func DedicatedHostId() interface{}
  • Type: interface{}

DeletionForceOptional

func DeletionForce() interface{}
  • Type: interface{}

DeletionProtectionOptional

func DeletionProtection() interface{}
  • Type: interface{}

DeploymentSetGroupNoOptional

func DeploymentSetGroupNo() interface{}
  • Type: interface{}

DeploymentSetIdOptional

func DeploymentSetId() interface{}
  • Type: interface{}

DescriptionOptional

func Description() interface{}
  • Type: interface{}

DiskMappingsOptional

func DiskMappings() interface{}
  • Type: interface{}

EniMappingsOptional

func EniMappings() interface{}
  • Type: interface{}

HostNameOptional

func HostName() interface{}
  • Type: interface{}

HostNamesOptional

func HostNames() interface{}
  • Type: interface{}

HpcClusterIdOptional

func HpcClusterId() interface{}
  • Type: interface{}

HttpEndpointOptional

func HttpEndpoint() interface{}
  • Type: interface{}

HttpTokensOptional

func HttpTokens() interface{}
  • Type: interface{}

ImageFamilyOptional

func ImageFamily() interface{}
  • Type: interface{}

ImageIdOptional

func ImageId() interface{}
  • Type: interface{}

ImageOptionsOptional

func ImageOptions() interface{}
  • Type: interface{}

InstanceChargeTypeOptional

func InstanceChargeType() interface{}
  • Type: interface{}

InstanceNameOptional

func InstanceName() interface{}
  • Type: interface{}

InternetChargeTypeOptional

func InternetChargeType() interface{}
  • Type: interface{}

InternetMaxBandwidthOutOptional

func InternetMaxBandwidthOut() interface{}
  • Type: interface{}

IoOptimizedOptional

func IoOptimized() interface{}
  • Type: interface{}

Ipv6AddressCountOptional

func Ipv6AddressCount() interface{}
  • Type: interface{}

Ipv6AddressesOptional

func Ipv6Addresses() interface{}
  • Type: interface{}

KeyPairNameOptional

func KeyPairName() interface{}
  • Type: interface{}

LaunchTemplateIdOptional

func LaunchTemplateId() interface{}
  • Type: interface{}

LaunchTemplateNameOptional

func LaunchTemplateName() interface{}
  • Type: interface{}

LaunchTemplateVersionOptional

func LaunchTemplateVersion() interface{}
  • Type: interface{}

NetworkInterfaceQueueNumberOptional

func NetworkInterfaceQueueNumber() interface{}
  • Type: interface{}

NetworkOptionsOptional

func NetworkOptions() interface{}
  • Type: interface{}

NetworkTypeOptional

func NetworkType() interface{}
  • Type: interface{}

PasswordOptional

func Password() interface{}
  • Type: interface{}

PasswordInheritOptional

func PasswordInherit() interface{}
  • Type: interface{}

PeriodOptional

func Period() interface{}
  • Type: interface{}

PeriodUnitOptional

func PeriodUnit() interface{}
  • Type: interface{}

PrivateIpAddressOptional

func PrivateIpAddress() interface{}
  • Type: interface{}

PrivatePoolOptionsOptional

func PrivatePoolOptions() interface{}
  • Type: interface{}

RamRoleNameOptional

func RamRoleName() interface{}
  • Type: interface{}

ResourceGroupIdOptional

func ResourceGroupId() interface{}
  • Type: interface{}

SchedulerOptionsOptional

func SchedulerOptions() interface{}
  • Type: interface{}

SecurityEnhancementStrategyOptional

func SecurityEnhancementStrategy() interface{}
  • Type: interface{}

SecurityGroupIdOptional

func SecurityGroupId() interface{}
  • Type: interface{}

SecurityGroupIdsOptional

func SecurityGroupIds() interface{}
  • Type: interface{}

SecurityOptionsOptional

func SecurityOptions() interface{}
  • Type: interface{}

SpotDurationOptional

func SpotDuration() interface{}
  • Type: interface{}

SpotInterruptionBehaviorOptional

func SpotInterruptionBehavior() interface{}
  • Type: interface{}

SpotPriceLimitOptional

func SpotPriceLimit() interface{}
  • Type: interface{}

SpotStrategyOptional

func SpotStrategy() interface{}
  • Type: interface{}

StorageSetIdOptional

func StorageSetId() interface{}
  • Type: interface{}

StorageSetPartitionNumberOptional

func StorageSetPartitionNumber() interface{}
  • Type: interface{}

SystemDiskAutoSnapshotPolicyIdOptional

func SystemDiskAutoSnapshotPolicyId() interface{}
  • Type: interface{}

SystemDiskBurstingEnabledOptional

func SystemDiskBurstingEnabled() interface{}
  • Type: interface{}

SystemDiskCategoryOptional

func SystemDiskCategory() interface{}
  • Type: interface{}

SystemDiskDescriptionOptional

func SystemDiskDescription() interface{}
  • Type: interface{}

SystemDiskDiskNameOptional

func SystemDiskDiskName() interface{}
  • Type: interface{}

SystemDiskEncryptAlgorithmOptional

func SystemDiskEncryptAlgorithm() interface{}
  • Type: interface{}

SystemDiskEncryptedOptional

func SystemDiskEncrypted() interface{}
  • Type: interface{}

SystemDiskKmsKeyIdOptional

func SystemDiskKmsKeyId() interface{}
  • Type: interface{}

SystemDiskPerformanceLevelOptional

func SystemDiskPerformanceLevel() interface{}
  • Type: interface{}

SystemDiskProvisionedIopsOptional

func SystemDiskProvisionedIops() interface{}
  • Type: interface{}

SystemDiskSizeOptional

func SystemDiskSize() interface{}
  • Type: interface{}

SystemDiskStorageClusterIdOptional

func SystemDiskStorageClusterId() interface{}
  • Type: interface{}

TagsOptional

func Tags() *[]TagsProperty

TenancyOptional

func Tenancy() interface{}
  • Type: interface{}

UniqueSuffixOptional

func UniqueSuffix() interface{}
  • Type: interface{}

UpdatePolicyOptional

func UpdatePolicy() interface{}
  • Type: interface{}

UseAdditionalServiceOptional

func UseAdditionalService() interface{}
  • Type: interface{}

UserDataOptional

func UserData() interface{}
  • Type: interface{}

VpcIdOptional

func VpcId() interface{}
  • Type: interface{}

VSwitchIdOptional

func VSwitchId() interface{}
  • Type: interface{}

ZoneIdOptional

func ZoneId() interface{}
  • Type: interface{}

ZoneIdsOptional

func ZoneIds() interface{}
  • Type: interface{}

Constants

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

RosResourceTypeNameRequired

func RosResourceTypeName() *string
  • Type: *string

The resource type name for this resource class.