Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::CR::Instance.

Initializers

import com.aliyun.ros.cdk.cr.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
//  .imageScanner(java.lang.String)
//  .imageScanner(IResolvable)
//  .instanceStorageName(java.lang.String)
//  .instanceStorageName(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .renewalStatus(java.lang.String)
//  .renewalStatus(IResolvable)
//  .renewPeriod(java.lang.Number)
//  .renewPeriod(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: Instance name.The value contains 3 to 30 lowercase letters, digits, and delimiters "-"(it can not be first or last).
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The Value configuration of the Group 1 attribute of Container Mirror Service Enterprise Edition.
imageScanner java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageScanner: Security scan engine.
instanceStorageName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceStorageName: Custom OSS Bucket name.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Prepaid cycle.
renewalStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property renewalStatus: Automatic renewal status, value: - AutoRenewal: automatic renewal.
renewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property renewPeriod: Automatic renewal cycle, in months.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: Instance name.The value contains 3 to 30 lowercase letters, digits, and delimiters "-"(it can not be first or last).


instanceTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: The Value configuration of the Group 1 attribute of Container Mirror Service Enterprise Edition.

Valid values: Basic: Basic instance Standard: Standard instance Advanced: Advanced Edition Instance.


imageScannerOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageScanner: Security scan engine.


instanceStorageNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceStorageName: Custom OSS Bucket name.


periodOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: Prepaid cycle.

The unit is Monthly, please enter an integer multiple of 12 for annual paid products.


renewalStatusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property renewalStatus: Automatic renewal status, value: - AutoRenewal: automatic renewal.

  • ManualRenewal: manual renewal. Default ManualRenewal.

renewPeriodOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property renewPeriod: Automatic renewal cycle, in months.

When RenewalStatus is set to AutoRenewal, it must be set.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.


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

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.cr.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The first ID of the resource.
attrInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: InstanceName.
attrInstanceSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceSpecification: The instance specification.
attrModifiedTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ModifiedTime: Last modification time.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
props InstanceProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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 java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the resource.


attrInstanceIdRequired

public java.lang.Object getAttrInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The first ID of the resource.


attrInstanceNameRequired

public java.lang.Object getAttrInstanceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: InstanceName.


attrInstanceSpecificationRequired

public java.lang.Object getAttrInstanceSpecification();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceSpecification: The instance specification.


attrModifiedTimeRequired

public java.lang.Object getAttrModifiedTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ModifiedTime: Last modification time.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


propsRequired

public InstanceProps getProps();