Skip to content

RosContainerGroup

This class is a base encapsulation around the ROS resource type ALIYUN::ECI::ContainerGroup, which is used to create a container group.

A container group is an elastic container instance.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkeci"
alicloudroscdkeci.NewRosContainerGroup(scope Construct, id *string, props RosContainerGroupProps, enableResourcePropertyConstraint *bool) RosContainerGroup
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 RosContainerGroupProps - 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/alicloudroscdkeci"
alicloudroscdkeci.RosContainerGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkeci"
alicloudroscdkeci.RosContainerGroup_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/alicloudroscdkeci"
alicloudroscdkeci.RosContainerGroup_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.
AttrContainerGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrContainerGroupName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrEniInstanceId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInternetIp github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIntranetIp github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIpv6Address github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrRegionId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrSecurityGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrVSwitchId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrZoneId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
Container interface{} No description.
ContainerGroupName interface{} No description.
EnableResourcePropertyConstraint *bool No description.
AcrRegistryInfo interface{} No description.
ActiveDeadlineSeconds interface{} No description.
AutoMatchImageCache interface{} No description.
Cpu interface{} No description.
DnsConfig interface{} No description.
EipInstanceId interface{} No description.
HostAliase interface{} No description.
ImageRegistryCredential interface{} No description.
ImageSnapshotId interface{} No description.
InitContainer interface{} No description.
InstanceType interface{} No description.
Ipv6AddressCount interface{} No description.
Memory interface{} No description.
RamRoleName interface{} No description.
ResourceGroupId interface{} No description.
RestartPolicy interface{} No description.
SecurityContextSysctl interface{} No description.
SecurityGroupId interface{} No description.
SlsEnable interface{} No description.
SpotPriceLimit interface{} No description.
SpotStrategy interface{} No description.
Tag interface{} No description.
TerminationGracePeriodSeconds interface{} No description.
Volume interface{} No description.
VSwitchId interface{} No description.
ZoneId 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.


AttrContainerGroupIdRequired

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

AttrContainerGroupNameRequired

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

AttrEniInstanceIdRequired

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

AttrInternetIpRequired

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

AttrIntranetIpRequired

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

AttrIpv6AddressRequired

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

AttrRegionIdRequired

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

AttrSecurityGroupIdRequired

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

AttrVSwitchIdRequired

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

AttrZoneIdRequired

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

ContainerRequired

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

ContainerGroupNameRequired

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

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

AcrRegistryInfoOptional

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

ActiveDeadlineSecondsOptional

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

AutoMatchImageCacheOptional

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

CpuOptional

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

DnsConfigOptional

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

EipInstanceIdOptional

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

HostAliaseOptional

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

ImageRegistryCredentialOptional

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

ImageSnapshotIdOptional

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

InitContainerOptional

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

InstanceTypeOptional

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

Ipv6AddressCountOptional

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

MemoryOptional

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

RamRoleNameOptional

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

ResourceGroupIdOptional

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

RestartPolicyOptional

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

SecurityContextSysctlOptional

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

SecurityGroupIdOptional

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

SlsEnableOptional

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

SpotPriceLimitOptional

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

SpotStrategyOptional

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

TagOptional

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

TerminationGracePeriodSecondsOptional

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

VolumeOptional

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

VSwitchIdOptional

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

ZoneIdOptional

func ZoneId() 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.