Gateway

• Implements: IGateway

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

Initializers

import ros_cdk_cloudstoragegateway
ros_cdk_cloudstoragegateway.Gateway(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

category^Required

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

Property category: The category of the gateway.

The default value is Cloud.

location^Required

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

Property location: The location of the gateway.

name^Required

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

type^Required

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

Property type: The type of the gateway.

description^Optional

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

Property description: The description of the gateway.

gateway_class^Optional

• 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_paid^Optional

• 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_bandwidth^Optional

• 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_expiration^Optional

• 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_id^Optional

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

Property resourceRegionId: The region ID of the resource.

secondary_v_switch_id^Optional

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

Property secondaryVSwitchId: The ID of the secondary VSwitch.

storage_bundle_id^Optional

• 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_id^Optional

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

Property untrustedEnvId: The ID of the untrusted environment.

untrusted_env_instance_type^Optional

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

Property untrustedEnvInstanceType: The instance type of the untrusted environment.

v_switch_id^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_cloudstoragegateway
ros_cdk_cloudstoragegateway.Gateway.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_gateway_id^Required

attr_gateway_id: typing.Union[str, IResolvable]

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

Attribute GatewayId: The ID of the gateway.

props^Required

props: GatewayProps

• Type: GatewayProps