Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Instance, which is used to create Edge Node Service (ENS) instances.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Ens;
new Instance(Construct Scope, string Id, InstanceProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props InstanceProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • 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.
AddCondition No description.
AddCount No description.
AddDependency No description.
AddResourceDesc No description.
ApplyRemovalPolicy No description.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc No description.
GetAtt No description.
SetMetadata No description.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Ens;
Instance.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAutoRenew object Attribute AutoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.
AttrAutoRenewPeriod object Attribute AutoRenewPeriod: The time period of auto renew.
AttrDataDiskSize object Attribute DataDiskSize: Disk size of the system disk, range from 20 to 500 GB.
AttrEnsRegionId object Attribute EnsRegionId: ENS Region Id.
AttrHostName object Attribute HostName: The hostname of the instance.
AttrImageId object Attribute ImageId: Image ID to create ens instance.
AttrInstanceId object Attribute InstanceId: InstanceId.
AttrInstanceName object Attribute InstanceName: Instance name.
AttrInstanceType object Attribute InstanceType: ENS instance supported instance type, make sure it should be correct.
AttrInternetChargeType object Attribute InternetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.
AttrIpType object Attribute IpType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.
AttrKeyPairName object Attribute KeyPairName: SSH key pair name.
AttrPaymentType object Attribute PaymentType: Payment Type.only support value Subscription.
AttrPeriod object Attribute Period: Prepaid time period.
AttrPrivateIpAddress object Attribute PrivateIpAddress: Private IP for the instance created.
AttrPrivateIps object Attribute PrivateIps: Private IP.
AttrPublicIps object Attribute PublicIps: Public IP.
AttrQuantity object Attribute Quantity: number of instances to create.
AttrSystemDiskSize object Attribute SystemDiskSize: Disk size of the system disk.
AttrUniqueSuffix object Attribute UniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.
AttrUserData object Attribute UserData: User data to pass to instance.
AttrVSwitchId object Attribute VSwitchId: The vSwitch Id to create ens instance.
Props InstanceProps No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment

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.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAutoRenewRequired

public object AttrAutoRenew { get; }
  • Type: object

Attribute AutoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.


AttrAutoRenewPeriodRequired

public object AttrAutoRenewPeriod { get; }
  • Type: object

Attribute AutoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.


AttrDataDiskSizeRequired

public object AttrDataDiskSize { get; }
  • Type: object

Attribute DataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.


AttrEnsRegionIdRequired

public object AttrEnsRegionId { get; }
  • Type: object

Attribute EnsRegionId: ENS Region Id.


AttrHostNameRequired

public object AttrHostName { get; }
  • Type: object

Attribute HostName: The hostname of the instance.


AttrImageIdRequired

public object AttrImageId { get; }
  • Type: object

Attribute ImageId: Image ID to create ens instance.


AttrInstanceIdRequired

public object AttrInstanceId { get; }
  • Type: object

Attribute InstanceId: InstanceId.


AttrInstanceNameRequired

public object AttrInstanceName { get; }
  • Type: object

Attribute InstanceName: Instance name.


AttrInstanceTypeRequired

public object AttrInstanceType { get; }
  • Type: object

Attribute InstanceType: ENS instance supported instance type, make sure it should be correct.


AttrInternetChargeTypeRequired

public object AttrInternetChargeType { get; }
  • Type: object

Attribute InternetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.


AttrIpTypeRequired

public object AttrIpType { get; }
  • Type: object

Attribute IpType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.


AttrKeyPairNameRequired

public object AttrKeyPairName { get; }
  • Type: object

Attribute KeyPairName: SSH key pair name.


AttrPaymentTypeRequired

public object AttrPaymentType { get; }
  • Type: object

Attribute PaymentType: Payment Type.only support value Subscription.


AttrPeriodRequired

public object AttrPeriod { get; }
  • Type: object

Attribute Period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.


AttrPrivateIpAddressRequired

public object AttrPrivateIpAddress { get; }
  • Type: object

Attribute PrivateIpAddress: Private IP for the instance created.


AttrPrivateIpsRequired

public object AttrPrivateIps { get; }
  • Type: object

Attribute PrivateIps: Private IP.


AttrPublicIpsRequired

public object AttrPublicIps { get; }
  • Type: object

Attribute PublicIps: Public IP.


AttrQuantityRequired

public object AttrQuantity { get; }
  • Type: object

Attribute Quantity: number of instances to create.


AttrSystemDiskSizeRequired

public object AttrSystemDiskSize { get; }
  • Type: object

Attribute SystemDiskSize: Disk size of the system disk.


AttrUniqueSuffixRequired

public object AttrUniqueSuffix { get; }
  • Type: object

Attribute UniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.


AttrUserDataRequired

public object AttrUserData { get; }
  • Type: object

Attribute UserData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.


AttrVSwitchIdRequired

public object AttrVSwitchId { get; }
  • Type: object

Attribute VSwitchId: The vSwitch Id to create ens instance.


PropsRequired

public InstanceProps Props { get; }