Gateway

• Implements: IGateway

This class encapsulates and extends the ROS resource type ALIYUN::CloudStorageGateway::Gateway.

Initializers

import com.aliyun.ros.cdk.cloudstoragegateway.Gateway;
Gateway.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .category(java.lang.String)
    .category(IResolvable)
    .location(java.lang.String)
    .location(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .gatewayClass(java.lang.String)
//  .gatewayClass(IResolvable)
//  .postPaid(java.lang.Boolean)
//  .postPaid(IResolvable)
//  .publicNetworkBandwidth(java.lang.Number)
//  .publicNetworkBandwidth(IResolvable)
//  .releaseAfterExpiration(java.lang.Boolean)
//  .releaseAfterExpiration(IResolvable)
//  .resourceRegionId(java.lang.String)
//  .resourceRegionId(IResolvable)
//  .secondaryVSwitchId(java.lang.String)
//  .secondaryVSwitchId(IResolvable)
//  .storageBundleId(java.lang.String)
//  .storageBundleId(IResolvable)
//  .untrustedEnvId(java.lang.String)
//  .untrustedEnvId(IResolvable)
//  .untrustedEnvInstanceType(java.lang.String)
//  .untrustedEnvInstanceType(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

category^Required

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

Property category: The category of the gateway.

The default value is Cloud.

location^Required

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

Property location: The location of the gateway.

name^Required

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

Property name: The name of the gateway.

The name must be 60 characters in length. The name must start with a letter or a Chinese character. The name can contain letters, Chinese characters, digits, underscores (_), hyphens (-), and periods (.).

type^Required

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

Property type: The type of the gateway.

description^Optional

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

Property description: The description of the gateway.

gatewayClass^Optional

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

Property gatewayClass: If your gateway is deployed in a data center, which is an on-premises gateway, you can ignore this parameter.

If your gateway is deployed on the cloud, which is a cloud gateway, valid values are:

• Basic: Basic
• Standard: Medium
• Enhanced: Enhanced
• Advanced: Performance

postPaid^Optional

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

Property postPaid: Valid values: - true: pay-as-you-go.

• false: subscription. Default value: false (subscription).

publicNetworkBandwidth^Optional

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

Property publicNetworkBandwidth: > - This parameter is supported only for cloud gateways.

You can ignore this parameter for on-premises gateways.

• Configure this parameter only when you need to mount an OSS bucket across regions.
• If you specify 0 or do not specify this parameter, the default value is 5.

releaseAfterExpiration^Optional

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

Property releaseAfterExpiration: Specifies whether to release the gateway when the subscription expires.

Valid values: true: The gateway is automatically released. false: The billing method of the gateway is automatically changed to pay-as-you-go after the subscription expires.

resourceRegionId^Optional

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

Property resourceRegionId: The region ID of the resource.

secondaryVSwitchId^Optional

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

Property secondaryVSwitchId: The ID of the secondary VSwitch.

storageBundleId^Optional

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

Property storageBundleId: The ID of the gateway cluster.

You must specify this parameter if you do not specify ResourceRegionId.

untrustedEnvId^Optional

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

Property untrustedEnvId: The ID of the untrusted environment.

untrustedEnvInstanceType^Optional

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

Property untrustedEnvInstanceType: The instance type of the untrusted environment.

vSwitchId^Optional

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

Property vSwitchId: The ID of the virtual switch.

If your gateway is deployed in a data center, you can ignore this parameter.

• The vSwitch must be in the same VPC as the ECS instance that you want to attach.
• If no gateway resources can be allocated in the zone where the vSwitch resides, create a vSwitch in another zone.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.cloudstoragegateway.Gateway;
Gateway.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrGatewayId^Required

public java.lang.Object getAttrGatewayId();

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

Attribute GatewayId: The ID of the gateway.

props^Required

public GatewayProps getProps();

• Type: GatewayProps