Docs Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. cloudstoragegateway
  5. Gateway
Alibaba Cloud v3.62.0 published on Tuesday, Sep 10, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.cloudstoragegateway.Gateway

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.0 published on Tuesday, Sep 10, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Cloud Storage Gateway Gateway resource.

    For information about Cloud Storage Gateway Gateway and how to use it, see What is Gateway.

    NOTE: Available since v1.132.0.

    Create Gateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
    @overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gateway_name: Optional[str] = None,
            location: Optional[str] = None,
            storage_bundle_id: Optional[str] = None,
            type: Optional[str] = None,
            description: Optional[str] = None,
            gateway_class: Optional[str] = None,
            payment_type: Optional[str] = None,
            public_network_bandwidth: Optional[int] = None,
            reason_detail: Optional[str] = None,
            reason_type: Optional[str] = None,
            release_after_expiration: Optional[bool] = None,
            vswitch_id: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: alicloud:cloudstoragegateway:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gatewayResource = new AliCloud.CloudStorageGateway.Gateway("gatewayResource", new()
{
    GatewayName = "string",
    Location = "string",
    StorageBundleId = "string",
    Type = "string",
    Description = "string",
    GatewayClass = "string",
    PaymentType = "string",
    PublicNetworkBandwidth = 0,
    ReasonDetail = "string",
    ReasonType = "string",
    ReleaseAfterExpiration = false,
    VswitchId = "string",
});

    example, err := cloudstoragegateway.NewGateway(ctx, "gatewayResource", &cloudstoragegateway.GatewayArgs{
	GatewayName:            pulumi.String("string"),
	Location:               pulumi.String("string"),
	StorageBundleId:        pulumi.String("string"),
	Type:                   pulumi.String("string"),
	Description:            pulumi.String("string"),
	GatewayClass:           pulumi.String("string"),
	PaymentType:            pulumi.String("string"),
	PublicNetworkBandwidth: pulumi.Int(0),
	ReasonDetail:           pulumi.String("string"),
	ReasonType:             pulumi.String("string"),
	ReleaseAfterExpiration: pulumi.Bool(false),
	VswitchId:              pulumi.String("string"),
})

    var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .gatewayName("string")
    .location("string")
    .storageBundleId("string")
    .type("string")
    .description("string")
    .gatewayClass("string")
    .paymentType("string")
    .publicNetworkBandwidth(0)
    .reasonDetail("string")
    .reasonType("string")
    .releaseAfterExpiration(false)
    .vswitchId("string")
    .build());

    gateway_resource = alicloud.cloudstoragegateway.Gateway("gatewayResource",
    gateway_name="string",
    location="string",
    storage_bundle_id="string",
    type="string",
    description="string",
    gateway_class="string",
    payment_type="string",
    public_network_bandwidth=0,
    reason_detail="string",
    reason_type="string",
    release_after_expiration=False,
    vswitch_id="string")

    const gatewayResource = new alicloud.cloudstoragegateway.Gateway("gatewayResource", {
    gatewayName: "string",
    location: "string",
    storageBundleId: "string",
    type: "string",
    description: "string",
    gatewayClass: "string",
    paymentType: "string",
    publicNetworkBandwidth: 0,
    reasonDetail: "string",
    reasonType: "string",
    releaseAfterExpiration: false,
    vswitchId: "string",
});

    type: alicloud:cloudstoragegateway:Gateway
properties:
    description: string
    gatewayClass: string
    gatewayName: string
    location: string
    paymentType: string
    publicNetworkBandwidth: 0
    reasonDetail: string
    reasonType: string
    releaseAfterExpiration: false
    storageBundleId: string
    type: string
    vswitchId: string

    Gateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Gateway resource accepts the following input properties:

    GatewayName string
    The name of the gateway.
    Location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    StorageBundleId string
    The ID of the gateway cluster.
    Type string
    The type of the gateway. Valid values: File, Iscsi.
    Description string
    The description of the gateway.
    GatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    PaymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    PublicNetworkBandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    ReasonDetail string
    The reason detail of gateway.
    ReasonType string
    The reason type when user deletes the gateway.
    ReleaseAfterExpiration bool
    Whether to release the gateway due to expiration.
    VswitchId string
    The ID of the vSwitch.
    GatewayName string
    The name of the gateway.
    Location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    StorageBundleId string
    The ID of the gateway cluster.
    Type string
    The type of the gateway. Valid values: File, Iscsi.
    Description string
    The description of the gateway.
    GatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    PaymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    PublicNetworkBandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    ReasonDetail string
    The reason detail of gateway.
    ReasonType string
    The reason type when user deletes the gateway.
    ReleaseAfterExpiration bool
    Whether to release the gateway due to expiration.
    VswitchId string
    The ID of the vSwitch.
    gatewayName String
    The name of the gateway.
    location String
    The location of the gateway. Valid values: Cloud, On_Premise.
    storageBundleId String
    The ID of the gateway cluster.
    type String
    The type of the gateway. Valid values: File, Iscsi.
    description String
    The description of the gateway.
    gatewayClass String
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    paymentType String
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth Integer
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail String
    The reason detail of gateway.
    reasonType String
    The reason type when user deletes the gateway.
    releaseAfterExpiration Boolean
    Whether to release the gateway due to expiration.
    vswitchId String
    The ID of the vSwitch.
    gatewayName string
    The name of the gateway.
    location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    storageBundleId string
    The ID of the gateway cluster.
    type string
    The type of the gateway. Valid values: File, Iscsi.
    description string
    The description of the gateway.
    gatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    paymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth number
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail string
    The reason detail of gateway.
    reasonType string
    The reason type when user deletes the gateway.
    releaseAfterExpiration boolean
    Whether to release the gateway due to expiration.
    vswitchId string
    The ID of the vSwitch.
    gateway_name str
    The name of the gateway.
    location str
    The location of the gateway. Valid values: Cloud, On_Premise.
    storage_bundle_id str
    The ID of the gateway cluster.
    type str
    The type of the gateway. Valid values: File, Iscsi.
    description str
    The description of the gateway.
    gateway_class str
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    payment_type str
    The Payment type of gateway. Valid values: PayAsYouGo.
    public_network_bandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reason_detail str
    The reason detail of gateway.
    reason_type str
    The reason type when user deletes the gateway.
    release_after_expiration bool
    Whether to release the gateway due to expiration.
    vswitch_id str
    The ID of the vSwitch.
    gatewayName String
    The name of the gateway.
    location String
    The location of the gateway. Valid values: Cloud, On_Premise.
    storageBundleId String
    The ID of the gateway cluster.
    type String
    The type of the gateway. Valid values: File, Iscsi.
    description String
    The description of the gateway.
    gatewayClass String
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    paymentType String
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth Number
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail String
    The reason detail of gateway.
    reasonType String
    The reason type when user deletes the gateway.
    releaseAfterExpiration Boolean
    Whether to release the gateway due to expiration.
    vswitchId String
    The ID of the vSwitch.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the Gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the Gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Gateway.

    Look up Existing Gateway Resource

    Get an existing Gateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        gateway_class: Optional[str] = None,
        gateway_name: Optional[str] = None,
        location: Optional[str] = None,
        payment_type: Optional[str] = None,
        public_network_bandwidth: Optional[int] = None,
        reason_detail: Optional[str] = None,
        reason_type: Optional[str] = None,
        release_after_expiration: Optional[bool] = None,
        status: Optional[str] = None,
        storage_bundle_id: Optional[str] = None,
        type: Optional[str] = None,
        vswitch_id: Optional[str] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the gateway.
    GatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    GatewayName string
    The name of the gateway.
    Location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    PaymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    PublicNetworkBandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    ReasonDetail string
    The reason detail of gateway.
    ReasonType string
    The reason type when user deletes the gateway.
    ReleaseAfterExpiration bool
    Whether to release the gateway due to expiration.
    Status string
    The status of the Gateway.
    StorageBundleId string
    The ID of the gateway cluster.
    Type string
    The type of the gateway. Valid values: File, Iscsi.
    VswitchId string
    The ID of the vSwitch.
    Description string
    The description of the gateway.
    GatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    GatewayName string
    The name of the gateway.
    Location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    PaymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    PublicNetworkBandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    ReasonDetail string
    The reason detail of gateway.
    ReasonType string
    The reason type when user deletes the gateway.
    ReleaseAfterExpiration bool
    Whether to release the gateway due to expiration.
    Status string
    The status of the Gateway.
    StorageBundleId string
    The ID of the gateway cluster.
    Type string
    The type of the gateway. Valid values: File, Iscsi.
    VswitchId string
    The ID of the vSwitch.
    description String
    The description of the gateway.
    gatewayClass String
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    gatewayName String
    The name of the gateway.
    location String
    The location of the gateway. Valid values: Cloud, On_Premise.
    paymentType String
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth Integer
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail String
    The reason detail of gateway.
    reasonType String
    The reason type when user deletes the gateway.
    releaseAfterExpiration Boolean
    Whether to release the gateway due to expiration.
    status String
    The status of the Gateway.
    storageBundleId String
    The ID of the gateway cluster.
    type String
    The type of the gateway. Valid values: File, Iscsi.
    vswitchId String
    The ID of the vSwitch.
    description string
    The description of the gateway.
    gatewayClass string
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    gatewayName string
    The name of the gateway.
    location string
    The location of the gateway. Valid values: Cloud, On_Premise.
    paymentType string
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth number
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail string
    The reason detail of gateway.
    reasonType string
    The reason type when user deletes the gateway.
    releaseAfterExpiration boolean
    Whether to release the gateway due to expiration.
    status string
    The status of the Gateway.
    storageBundleId string
    The ID of the gateway cluster.
    type string
    The type of the gateway. Valid values: File, Iscsi.
    vswitchId string
    The ID of the vSwitch.
    description str
    The description of the gateway.
    gateway_class str
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    gateway_name str
    The name of the gateway.
    location str
    The location of the gateway. Valid values: Cloud, On_Premise.
    payment_type str
    The Payment type of gateway. Valid values: PayAsYouGo.
    public_network_bandwidth int
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reason_detail str
    The reason detail of gateway.
    reason_type str
    The reason type when user deletes the gateway.
    release_after_expiration bool
    Whether to release the gateway due to expiration.
    status str
    The status of the Gateway.
    storage_bundle_id str
    The ID of the gateway cluster.
    type str
    The type of the gateway. Valid values: File, Iscsi.
    vswitch_id str
    The ID of the vSwitch.
    description String
    The description of the gateway.
    gatewayClass String
    The specification of the gateway. Valid values: Basic, Standard,Enhanced,Advanced.
    gatewayName String
    The name of the gateway.
    location String
    The location of the gateway. Valid values: Cloud, On_Premise.
    paymentType String
    The Payment type of gateway. Valid values: PayAsYouGo.
    publicNetworkBandwidth Number
    The public network bandwidth of gateway. Default value: 5. Valid values: 5 to 200.
    reasonDetail String
    The reason detail of gateway.
    reasonType String
    The reason type when user deletes the gateway.
    releaseAfterExpiration Boolean
    Whether to release the gateway due to expiration.
    status String
    The status of the Gateway.
    storageBundleId String
    The ID of the gateway cluster.
    type String
    The type of the gateway. Valid values: File, Iscsi.
    vswitchId String
    The ID of the vSwitch.

    Import

    Cloud Storage Gateway Gateway can be imported using the id, e.g.

    $ pulumi import alicloud:cloudstoragegateway/gateway:Gateway example <id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.0 published on Tuesday, Sep 10, 2024 by Pulumi
    pulumi/pulumi-alicloud