Skip to content

OriginInstance

This class encapsulates and extends the ROS resource type ALIYUN::DDoS::OriginInstance, which is used to create an Anti-DDoS Origin instance.

Initializers 

import com.aliyun.ros.cdk.ddos.OriginInstance;
OriginInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .edition(java.lang.String)
    .edition(IResolvable)
    .protectionMode(java.lang.String)
    .protectionMode(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .cleanBandwidth(java.lang.Number)
//  .cleanBandwidth(IResolvable)
//  .enableLog(java.lang.Boolean)
//  .enableLog(IResolvable)
//  .ipAddresses(java.lang.Number)
//  .ipAddresses(IResolvable)
//  .networkProtocol(java.lang.String)
//  .networkProtocol(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .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.
edition java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property edition: Edition of the instance.
protectionMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protectionMode: The mode of the protection.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The charge type of the instance.
cleanBandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cleanBandwidth: The mitigation capability of Anti-DDoS is measured by the inbound or outbound clean bandwidth.
enableLog java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableLog: Whether to enable protection logs.
ipAddresses java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ipAddresses: The number of ip addresses.
networkProtocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkProtocol: The network protocol of the instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The period of the instance.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The period unit of the instance.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

editionRequired

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

Property edition: Edition of the instance.

Valid values:

  • enterprise: Enterprise Edition.
  • smb: Affordable and general edition for small and medium-sized enterprises.

protectionModeRequired

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

Property protectionMode: The mode of the protection.

Valid values: unlimited: The Unlimited protection mode is intended for internal use within enterprises.

chargeTypeOptional

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

Property chargeType: The charge type of the instance.

Valid values: PostPaid: Pay-as-you-go. PrePaid: Subscription.

cleanBandwidthOptional

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

Property cleanBandwidth: The mitigation capability of Anti-DDoS is measured by the inbound or outbound clean bandwidth.

When Edition is enterprise, CleanBandwidth ranges from 100 to 1000 Mbit/s.When Edition is smb， CleanBandwidth ranges from 50 to 1000 Mbit/s.

enableLogOptional

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

Property enableLog: Whether to enable protection logs.

ipAddressesOptional

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

Property ipAddresses: The number of ip addresses.

When Edition is smb， IP Addresses ranges from 1 to 29. When Edition is enterprise, The minimum number of IP Addresses is 30.

networkProtocolOptional

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

Property networkProtocol: The network protocol of the instance.

Valid values: v4: IPv4. v6: IPv6. v4_6: IPv4+IPv6.

periodOptional

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

Property period: The period of the instance.

periodUnitOptional

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

Property periodUnit: The period unit of the instance.

Valid values: Month: Month. Year: Year.

tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

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.
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

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.ddos.OriginInstance;
OriginInstance.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.
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 com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the instance.

nodeRequired 

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

The construct tree node associated with this construct.

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 IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the instance.