Skip to content

GatewayProps

Properties for defining a Gateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudstoragegateway-gateway

Initializer

import com.aliyun.ros.cdk.cloudstoragegateway.GatewayProps;
GatewayProps.builder()
    .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();

Properties

Name Type Description
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The category of the gateway.
location java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property location: The location of the gateway.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the gateway.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: The type of the gateway.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the gateway.
gatewayClass 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.
postPaid java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property postPaid: Valid values: - true: pay-as-you-go.
publicNetworkBandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property publicNetworkBandwidth: > - This parameter is supported only for cloud gateways.
releaseAfterExpiration java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property releaseAfterExpiration: Specifies whether to release the gateway when the subscription expires.
resourceRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceRegionId: The region ID of the resource.
secondaryVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondaryVSwitchId: The ID of the secondary VSwitch.
storageBundleId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageBundleId: The ID of the gateway cluster.
untrustedEnvId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property untrustedEnvId: The ID of the untrusted environment.
untrustedEnvInstanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property untrustedEnvInstanceType: The instance type of the untrusted environment.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the virtual switch.

categoryRequired

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

Property category: The category of the gateway.

The default value is Cloud.


locationRequired

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

Property location: The location of the gateway.


nameRequired

public java.lang.Object getName();
  • 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 (.).


typeRequired

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

Property type: The type of the gateway.


descriptionOptional

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

Property description: The description of the gateway.


gatewayClassOptional

public java.lang.Object getGatewayClass();
  • 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

postPaidOptional

public java.lang.Object getPostPaid();
  • 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).

publicNetworkBandwidthOptional

public java.lang.Object getPublicNetworkBandwidth();
  • 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.

releaseAfterExpirationOptional

public java.lang.Object getReleaseAfterExpiration();
  • 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.


resourceRegionIdOptional

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

Property resourceRegionId: The region ID of the resource.


secondaryVSwitchIdOptional

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

Property secondaryVSwitchId: The ID of the secondary VSwitch.


storageBundleIdOptional

public java.lang.Object getStorageBundleId();
  • 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.


untrustedEnvIdOptional

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

Property untrustedEnvId: The ID of the untrusted environment.


untrustedEnvInstanceTypeOptional

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

Property untrustedEnvInstanceType: The instance type of the untrusted environment.


vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • 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.