Skip to content

GatewayProps

Properties for defining a Gateway.

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

Initializer

import { GatewayProps } from '@alicloud/ros-cdk-cloudstoragegateway'
const gatewayProps: GatewayProps = { ... }

Properties

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

categoryRequired

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The category of the gateway.

The default value is Cloud.


locationRequired

public readonly location: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property location: The location of the gateway.


nameRequired

public readonly name: string | IResolvable;
  • Type: string | @alicloud/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 readonly type: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property type: The type of the gateway.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the gateway.


gatewayClassOptional

public readonly gatewayClass: string | IResolvable;
  • Type: string | @alicloud/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 readonly postPaid: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

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


publicNetworkBandwidthOptional

public readonly publicNetworkBandwidth: number | IResolvable;
  • Type: number | @alicloud/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 readonly releaseAfterExpiration: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly resourceRegionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceRegionId: The region ID of the resource.


secondaryVSwitchIdOptional

public readonly secondaryVSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property secondaryVSwitchId: The ID of the secondary VSwitch.


storageBundleIdOptional

public readonly storageBundleId: string | IResolvable;
  • Type: string | @alicloud/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 readonly untrustedEnvId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property untrustedEnvId: The ID of the untrusted environment.


untrustedEnvInstanceTypeOptional

public readonly untrustedEnvInstanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property untrustedEnvInstanceType: The instance type of the untrusted environment.


vSwitchIdOptional

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/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.