Skip to content

GatewayProps

Properties for defining a Gateway.

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

Initializer

import ros_cdk_cloudstoragegateway
ros_cdk_cloudstoragegateway.GatewayProps(
  category: typing.Union[str, IResolvable],
  location: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  type: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  gateway_class: typing.Union[str, IResolvable] = None,
  post_paid: typing.Union[bool, IResolvable] = None,
  public_network_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  release_after_expiration: typing.Union[bool, IResolvable] = None,
  resource_region_id: typing.Union[str, IResolvable] = None,
  secondary_v_switch_id: typing.Union[str, IResolvable] = None,
  storage_bundle_id: typing.Union[str, IResolvable] = None,
  untrusted_env_id: typing.Union[str, IResolvable] = None,
  untrusted_env_instance_type: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
category typing.Union[str, ros_cdk_core.IResolvable] Property category: The category of the gateway.
location typing.Union[str, ros_cdk_core.IResolvable] Property location: The location of the gateway.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the gateway.
type typing.Union[str, ros_cdk_core.IResolvable] Property type: The type of the gateway.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the gateway.
gateway_class typing.Union[str, 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.
post_paid typing.Union[bool, ros_cdk_core.IResolvable] Property postPaid: Valid values: - true: pay-as-you-go.
public_network_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property publicNetworkBandwidth: > - This parameter is supported only for cloud gateways.
release_after_expiration typing.Union[bool, ros_cdk_core.IResolvable] Property releaseAfterExpiration: Specifies whether to release the gateway when the subscription expires.
resource_region_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceRegionId: The region ID of the resource.
secondary_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property secondaryVSwitchId: The ID of the secondary VSwitch.
storage_bundle_id typing.Union[str, ros_cdk_core.IResolvable] Property storageBundleId: The ID of the gateway cluster.
untrusted_env_id typing.Union[str, ros_cdk_core.IResolvable] Property untrustedEnvId: The ID of the untrusted environment.
untrusted_env_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property untrustedEnvInstanceType: The instance type of the untrusted environment.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the virtual switch.

categoryRequired

category: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property category: The category of the gateway.

The default value is Cloud.


locationRequired

location: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property location: The location of the gateway.


nameRequired

name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property type: The type of the gateway.


descriptionOptional

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the gateway.


gateway_classOptional

gateway_class: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

post_paidOptional

post_paid: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

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

public_network_bandwidthOptional

public_network_bandwidth: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

release_after_expirationOptional

release_after_expiration: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.


resource_region_idOptional

resource_region_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceRegionId: The region ID of the resource.


secondary_v_switch_idOptional

secondary_v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property secondaryVSwitchId: The ID of the secondary VSwitch.


storage_bundle_idOptional

storage_bundle_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property storageBundleId: The ID of the gateway cluster.

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


untrusted_env_idOptional

untrusted_env_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property untrustedEnvId: The ID of the untrusted environment.


untrusted_env_instance_typeOptional

untrusted_env_instance_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property untrustedEnvInstanceType: The instance type of the untrusted environment.


v_switch_idOptional

v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.