1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cloudstoragegateway
  5. ExpressSync
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.cloudstoragegateway.ExpressSync

Explore with Pulumi AI

Provides a Cloud Storage Gateway Express Sync resource.

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

NOTE: Available since v1.144.0.

Create ExpressSync Resource

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

Constructor syntax

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

@overload
def ExpressSync(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                bucket_name: Optional[str] = None,
                bucket_region: Optional[str] = None,
                express_sync_name: Optional[str] = None,
                bucket_prefix: Optional[str] = None,
                description: Optional[str] = None)
func NewExpressSync(ctx *Context, name string, args ExpressSyncArgs, opts ...ResourceOption) (*ExpressSync, error)
public ExpressSync(string name, ExpressSyncArgs args, CustomResourceOptions? opts = null)
public ExpressSync(String name, ExpressSyncArgs args)
public ExpressSync(String name, ExpressSyncArgs args, CustomResourceOptions options)
type: alicloud:cloudstoragegateway:ExpressSync
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExpressSyncArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExpressSyncArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressSyncArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressSyncArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExpressSyncArgs
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 expressSyncResource = new AliCloud.CloudStorageGateway.ExpressSync("expressSyncResource", new()
{
    BucketName = "string",
    BucketRegion = "string",
    ExpressSyncName = "string",
    BucketPrefix = "string",
    Description = "string",
});
Copy
example, err := cloudstoragegateway.NewExpressSync(ctx, "expressSyncResource", &cloudstoragegateway.ExpressSyncArgs{
	BucketName:      pulumi.String("string"),
	BucketRegion:    pulumi.String("string"),
	ExpressSyncName: pulumi.String("string"),
	BucketPrefix:    pulumi.String("string"),
	Description:     pulumi.String("string"),
})
Copy
var expressSyncResource = new ExpressSync("expressSyncResource", ExpressSyncArgs.builder()
    .bucketName("string")
    .bucketRegion("string")
    .expressSyncName("string")
    .bucketPrefix("string")
    .description("string")
    .build());
Copy
express_sync_resource = alicloud.cloudstoragegateway.ExpressSync("expressSyncResource",
    bucket_name="string",
    bucket_region="string",
    express_sync_name="string",
    bucket_prefix="string",
    description="string")
Copy
const expressSyncResource = new alicloud.cloudstoragegateway.ExpressSync("expressSyncResource", {
    bucketName: "string",
    bucketRegion: "string",
    expressSyncName: "string",
    bucketPrefix: "string",
    description: "string",
});
Copy
type: alicloud:cloudstoragegateway:ExpressSync
properties:
    bucketName: string
    bucketPrefix: string
    bucketRegion: string
    description: string
    expressSyncName: string
Copy

ExpressSync Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ExpressSync resource accepts the following input properties:

BucketName
This property is required.
Changes to this property will trigger replacement.
string
The name of the OSS Bucket.
BucketRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the OSS Bucket.
ExpressSyncName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
BucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
Description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
BucketName
This property is required.
Changes to this property will trigger replacement.
string
The name of the OSS Bucket.
BucketRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the OSS Bucket.
ExpressSyncName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
BucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
Description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
bucketName
This property is required.
Changes to this property will trigger replacement.
String
The name of the OSS Bucket.
bucketRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the OSS Bucket.
expressSyncName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketPrefix Changes to this property will trigger replacement. String
The prefix of the OSS Bucket.
description Changes to this property will trigger replacement. String
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
bucketName
This property is required.
Changes to this property will trigger replacement.
string
The name of the OSS Bucket.
bucketRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the OSS Bucket.
expressSyncName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
bucket_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the OSS Bucket.
bucket_region
This property is required.
Changes to this property will trigger replacement.
str
The region of the OSS Bucket.
express_sync_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucket_prefix Changes to this property will trigger replacement. str
The prefix of the OSS Bucket.
description Changes to this property will trigger replacement. str
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
bucketName
This property is required.
Changes to this property will trigger replacement.
String
The name of the OSS Bucket.
bucketRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the OSS Bucket.
expressSyncName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketPrefix Changes to this property will trigger replacement. String
The prefix of the OSS Bucket.
description Changes to this property will trigger replacement. String
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ExpressSync Resource

Get an existing ExpressSync 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?: ExpressSyncState, opts?: CustomResourceOptions): ExpressSync
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_name: Optional[str] = None,
        bucket_prefix: Optional[str] = None,
        bucket_region: Optional[str] = None,
        description: Optional[str] = None,
        express_sync_name: Optional[str] = None) -> ExpressSync
func GetExpressSync(ctx *Context, name string, id IDInput, state *ExpressSyncState, opts ...ResourceOption) (*ExpressSync, error)
public static ExpressSync Get(string name, Input<string> id, ExpressSyncState? state, CustomResourceOptions? opts = null)
public static ExpressSync get(String name, Output<String> id, ExpressSyncState state, CustomResourceOptions options)
resources:  _:    type: alicloud:cloudstoragegateway:ExpressSync    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BucketName Changes to this property will trigger replacement. string
The name of the OSS Bucket.
BucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
BucketRegion Changes to this property will trigger replacement. string
The region of the OSS Bucket.
Description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
ExpressSyncName Changes to this property will trigger replacement. string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
BucketName Changes to this property will trigger replacement. string
The name of the OSS Bucket.
BucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
BucketRegion Changes to this property will trigger replacement. string
The region of the OSS Bucket.
Description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
ExpressSyncName Changes to this property will trigger replacement. string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketName Changes to this property will trigger replacement. String
The name of the OSS Bucket.
bucketPrefix Changes to this property will trigger replacement. String
The prefix of the OSS Bucket.
bucketRegion Changes to this property will trigger replacement. String
The region of the OSS Bucket.
description Changes to this property will trigger replacement. String
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
expressSyncName Changes to this property will trigger replacement. String
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketName Changes to this property will trigger replacement. string
The name of the OSS Bucket.
bucketPrefix Changes to this property will trigger replacement. string
The prefix of the OSS Bucket.
bucketRegion Changes to this property will trigger replacement. string
The region of the OSS Bucket.
description Changes to this property will trigger replacement. string
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
expressSyncName Changes to this property will trigger replacement. string
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucket_name Changes to this property will trigger replacement. str
The name of the OSS Bucket.
bucket_prefix Changes to this property will trigger replacement. str
The prefix of the OSS Bucket.
bucket_region Changes to this property will trigger replacement. str
The region of the OSS Bucket.
description Changes to this property will trigger replacement. str
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
express_sync_name Changes to this property will trigger replacement. str
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.
bucketName Changes to this property will trigger replacement. String
The name of the OSS Bucket.
bucketPrefix Changes to this property will trigger replacement. String
The prefix of the OSS Bucket.
bucketRegion Changes to this property will trigger replacement. String
The region of the OSS Bucket.
description Changes to this property will trigger replacement. String
The description of the Express Sync. The length of the name is limited to 1 to 255 characters.
expressSyncName Changes to this property will trigger replacement. String
The name of the ExpressSync. The length of the name is limited to 1 to 128 characters. It can contain uppercase and lowercase letters, Chinese characters, numbers, English periods (.), underscores (_), or hyphens (-), and must start with letters.

Import

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

$ pulumi import alicloud:cloudstoragegateway/expressSync:ExpressSync example <id>
Copy

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.