Instance
- Implements: IInstance
This class encapsulates and extends the ROS resource type ALIYUN::DNS::Instance.
Initializers
import com.aliyun.ros.cdk.dns.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.dnsSecurity(java.lang.String)
.dnsSecurity(IResolvable)
.domainNumbers(java.lang.Number)
.domainNumbers(IResolvable)
.period(java.lang.Number)
.period(IResolvable)
.periodUnit(java.lang.String)
.periodUnit(IResolvable)
.version(java.lang.String)
.version(IResolvable)
// .domain(java.lang.String)
// .domain(IResolvable)
// .instanceType(java.lang.String)
// .instanceType(IResolvable)
// .renewalStatus(java.lang.String)
// .renewalStatus(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. |
dnsSecurity | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dnsSecurity: The DNS security policy. |
domainNumbers | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property domainNumbers: The number of domain names. |
period | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property period: The subscription duration. |
periodUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property periodUnit: The subscription duration unit. |
version | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property version: The edition of Alibaba Cloud DNS. |
domain | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property domain: The domain name that you want to bind to the instance. |
instanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceType: The type of the instance. |
renewalStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property renewalStatus: The renewal method. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dnsSecurityRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dnsSecurity: The DNS security policy.
Valid values:
- no: No protection against DNS attacks is provided.
- basic: Basic protection against DNS attacks is provided.
- advanced: Advanced protection against DNS attacks is provided.
domainNumbersRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property domainNumbers: The number of domain names.
periodRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: The subscription duration.
Valid values:
- If unit is month: 1, 2, 3, 6
- If unit is year: 1, 2
periodUnitRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property periodUnit: The subscription duration unit.
versionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property version: The edition of Alibaba Cloud DNS.
Valid values: If create hosted public zone:
- version_personal: Personal Edition.
- version_enterprise_basic: Enterprise Standard Edition.
- version_enterprise_advanced: Enterprise Ultimate Edition. If create cached public zone:
- version_cached_basicNote: Only upgrade operations are supported after instance creation.
domainOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property domain: The domain name that you want to bind to the instance.
If you want to bind multiple domain names to the instance, separate these domain names with commas (,).
instanceTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceType: The type of the instance.
Valid values:
- HostedPublicZone: Hosted Public Zone
- CachedPublicZone: Cached Public Zone.
renewalStatusOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property renewalStatus: The renewal method.
Valid values:
- AutoRenewal: The instance is automatically renewed.
- ManualRenewal: The instance is manually renewed. Default value: ManualRenewal.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.dns.Instance;
Instance.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: DNS instance id. |
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
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: DNS instance id.
propsRequired
public InstanceProps getProps();
- Type: InstanceProps