This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

oss

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.oss.AwaitableGetBucketObjectsResult(bucket_name=None, id=None, key_prefix=None, key_regex=None, objects=None, output_file=None)
class pulumi_alicloud.oss.AwaitableGetBucketsResult(buckets=None, id=None, name_regex=None, names=None, output_file=None)
class pulumi_alicloud.oss.AwaitableGetInstanceAttachmentsResult(attachments=None, id=None, instance_name=None, name_regex=None, names=None, output_file=None, vpc_ids=None)
class pulumi_alicloud.oss.AwaitableGetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)
class pulumi_alicloud.oss.AwaitableGetTablesResult(id=None, ids=None, instance_name=None, name_regex=None, names=None, output_file=None, tables=None)
class pulumi_alicloud.oss.Bucket(resource_name, opts=None, acl=None, bucket=None, cors_rules=None, force_destroy=None, lifecycle_rules=None, logging=None, logging_isenable=None, policy=None, referer_config=None, server_side_encryption_rule=None, storage_class=None, tags=None, versioning=None, website=None, __props__=None, __name__=None, __opts__=None)

Provides a resource to create a oss bucket and set its attribution.

NOTE: The bucket namespace is shared by all users of the OSS system. Please set bucket name as unique as possible.

import pulumi
import pulumi_alicloud as alicloud

bucket_acl = alicloud.oss.Bucket("bucket-acl",
    acl="private",
    bucket="bucket-170309-acl")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) – The canned ACL to apply. Can be “private”, “public-read” and “public-read-write”. Defaults to “private”.

  • cors_rules (pulumi.Input[list]) – A rule of Cross-Origin Resource Sharing (documented below). The items of core rule are no more than 10 for every OSS bucket.

  • force_destroy (pulumi.Input[bool]) – A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. Defaults to “false”.

  • lifecycle_rules (pulumi.Input[list]) – A configuration of object lifecycle management (documented below).

  • logging (pulumi.Input[dict]) – A Settings of bucket logging (documented below).

  • logging_isenable (pulumi.Input[bool]) – The flag of using logging enable container. Defaults true.

  • policy (pulumi.Input[str]) – Json format text of bucket policy bucket policy management.

  • referer_config (pulumi.Input[dict]) – The configuration of referer (documented below).

  • server_side_encryption_rule (pulumi.Input[dict]) – A configuration of server-side encryption (documented below).

  • storage_class (pulumi.Input[str]) – Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the bucket. The items are no more than 10 for a bucket.

  • versioning (pulumi.Input[dict]) – A state of versioning (documented below).

  • website (pulumi.Input[dict]) – A website object(documented below).

The cors_rules object supports the following:

  • allowedHeaders (pulumi.Input[list]) - Specifies which headers are allowed.

  • allowedMethods (pulumi.Input[list]) - Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.

  • allowedOrigins (pulumi.Input[list]) - Specifies which origins are allowed.

  • exposeHeaders (pulumi.Input[list]) - Specifies expose header in the response.

  • maxAgeSeconds (pulumi.Input[float]) - Specifies time in seconds that browser can cache the response for a preflight request.

The lifecycle_rules object supports the following:

  • enabled (pulumi.Input[bool]) - Specifies lifecycle rule status.

  • expirations (pulumi.Input[list]) - Specifies a period in the object’s expire (documented below).

    • date (pulumi.Input[str]) - Specifies the date after which you want the corresponding action to take effect. The value obeys ISO8601 format like 2017-03-09.

    • days (pulumi.Input[float]) - Specifies the number of days after object creation when the specific rule action takes effect.

  • id (pulumi.Input[str]) - Unique identifier for the rule. If omitted, OSS bucket will assign a unique name.

  • prefix (pulumi.Input[str]) - Object key prefix identifying one or more objects to which the rule applies.

  • transitions (pulumi.Input[list]) - Specifies the time when an object is converted to the IA or archive storage class during a valid life cycle. (documented below).

    • createdBeforeDate (pulumi.Input[str]) - Specifies the time before which the rules take effect. The date must conform to the ISO8601 format and always be UTC 00:00. For example: 2002-10-11T00:00:00.000Z indicates that objects updated before 2002-10-11T00:00:00.000Z are deleted or converted to another storage class, and objects updated after this time (including this time) are not deleted or converted.

    • days (pulumi.Input[float]) - Specifies the number of days after object creation when the specific rule action takes effect.

    • storage_class (pulumi.Input[str]) - Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

The logging object supports the following:

  • targetBucket (pulumi.Input[str]) - The name of the bucket that will receive the log objects.

  • targetPrefix (pulumi.Input[str]) - To specify a key prefix for log objects.

The referer_config object supports the following:

  • allowEmpty (pulumi.Input[bool]) - Allows referer to be empty. Defaults false.

  • referers (pulumi.Input[list]) - The list of referer.

The server_side_encryption_rule object supports the following:

  • sseAlgorithm (pulumi.Input[str]) - The server-side encryption algorithm to use. Possible values: AES256 and KMS.

The versioning object supports the following:

  • status (pulumi.Input[str]) - Specifies the versioning state of a bucket. Valid values: Enabled and Suspended.

The website object supports the following:

  • errorDocument (pulumi.Input[str]) - An absolute path to the document to return in case of a 4XX error.

  • indexDocument (pulumi.Input[str]) - Alicloud OSS returns this index document when requests are made to the root domain or any of the subfolders.

acl: pulumi.Output[str] = None

The canned ACL to apply. Can be “private”, “public-read” and “public-read-write”. Defaults to “private”.

cors_rules: pulumi.Output[list] = None

A rule of Cross-Origin Resource Sharing (documented below). The items of core rule are no more than 10 for every OSS bucket.

  • allowedHeaders (list) - Specifies which headers are allowed.

  • allowedMethods (list) - Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.

  • allowedOrigins (list) - Specifies which origins are allowed.

  • exposeHeaders (list) - Specifies expose header in the response.

  • maxAgeSeconds (float) - Specifies time in seconds that browser can cache the response for a preflight request.

creation_date: pulumi.Output[str] = None

The creation date of the bucket.

extranet_endpoint: pulumi.Output[str] = None

The extranet access endpoint of the bucket.

force_destroy: pulumi.Output[bool] = None

A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. Defaults to “false”.

intranet_endpoint: pulumi.Output[str] = None

The intranet access endpoint of the bucket.

lifecycle_rules: pulumi.Output[list] = None

A configuration of object lifecycle management (documented below).

  • enabled (bool) - Specifies lifecycle rule status.

  • expirations (list) - Specifies a period in the object’s expire (documented below).

    • date (str) - Specifies the date after which you want the corresponding action to take effect. The value obeys ISO8601 format like 2017-03-09.

    • days (float) - Specifies the number of days after object creation when the specific rule action takes effect.

  • id (str) - Unique identifier for the rule. If omitted, OSS bucket will assign a unique name.

  • prefix (str) - Object key prefix identifying one or more objects to which the rule applies.

  • transitions (list) - Specifies the time when an object is converted to the IA or archive storage class during a valid life cycle. (documented below).

    • createdBeforeDate (str) - Specifies the time before which the rules take effect. The date must conform to the ISO8601 format and always be UTC 00:00. For example: 2002-10-11T00:00:00.000Z indicates that objects updated before 2002-10-11T00:00:00.000Z are deleted or converted to another storage class, and objects updated after this time (including this time) are not deleted or converted.

    • days (float) - Specifies the number of days after object creation when the specific rule action takes effect.

    • storage_class (str) - Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

location: pulumi.Output[str] = None

The location of the bucket.

logging: pulumi.Output[dict] = None

A Settings of bucket logging (documented below).

  • targetBucket (str) - The name of the bucket that will receive the log objects.

  • targetPrefix (str) - To specify a key prefix for log objects.

logging_isenable: pulumi.Output[bool] = None

The flag of using logging enable container. Defaults true.

owner: pulumi.Output[str] = None

The bucket owner.

policy: pulumi.Output[str] = None

Json format text of bucket policy bucket policy management.

referer_config: pulumi.Output[dict] = None

The configuration of referer (documented below).

  • allowEmpty (bool) - Allows referer to be empty. Defaults false.

  • referers (list) - The list of referer.

server_side_encryption_rule: pulumi.Output[dict] = None

A configuration of server-side encryption (documented below).

  • sseAlgorithm (str) - The server-side encryption algorithm to use. Possible values: AES256 and KMS.

storage_class: pulumi.Output[str] = None

Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the bucket. The items are no more than 10 for a bucket.

versioning: pulumi.Output[dict] = None

A state of versioning (documented below).

  • status (str) - Specifies the versioning state of a bucket. Valid values: Enabled and Suspended.

website: pulumi.Output[dict] = None

A website object(documented below).

  • errorDocument (str) - An absolute path to the document to return in case of a 4XX error.

  • indexDocument (str) - Alicloud OSS returns this index document when requests are made to the root domain or any of the subfolders.

static get(resource_name, id, opts=None, acl=None, bucket=None, cors_rules=None, creation_date=None, extranet_endpoint=None, force_destroy=None, intranet_endpoint=None, lifecycle_rules=None, location=None, logging=None, logging_isenable=None, owner=None, policy=None, referer_config=None, server_side_encryption_rule=None, storage_class=None, tags=None, versioning=None, website=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) –

    The canned ACL to apply. Can be “private”, “public-read” and “public-read-write”. Defaults to “private”.

  • cors_rules (pulumi.Input[list]) –

    A rule of Cross-Origin Resource Sharing (documented below). The items of core rule are no more than 10 for every OSS bucket.

  • creation_date (pulumi.Input[str]) – The creation date of the bucket.

  • extranet_endpoint (pulumi.Input[str]) – The extranet access endpoint of the bucket.

  • force_destroy (pulumi.Input[bool]) – A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. Defaults to “false”.

  • intranet_endpoint (pulumi.Input[str]) – The intranet access endpoint of the bucket.

  • lifecycle_rules (pulumi.Input[list]) –

    A configuration of object lifecycle management (documented below).

  • location (pulumi.Input[str]) – The location of the bucket.

  • logging (pulumi.Input[dict]) –

    A Settings of bucket logging (documented below).

  • logging_isenable (pulumi.Input[bool]) – The flag of using logging enable container. Defaults true.

  • owner (pulumi.Input[str]) – The bucket owner.

  • policy (pulumi.Input[str]) –

    Json format text of bucket policy bucket policy management.

  • referer_config (pulumi.Input[dict]) –

    The configuration of referer (documented below).

  • server_side_encryption_rule (pulumi.Input[dict]) – A configuration of server-side encryption (documented below).

  • storage_class (pulumi.Input[str]) – Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the bucket. The items are no more than 10 for a bucket.

  • versioning (pulumi.Input[dict]) – A state of versioning (documented below).

  • website (pulumi.Input[dict]) – A website object(documented below).

The cors_rules object supports the following:

  • allowedHeaders (pulumi.Input[list]) - Specifies which headers are allowed.

  • allowedMethods (pulumi.Input[list]) - Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.

  • allowedOrigins (pulumi.Input[list]) - Specifies which origins are allowed.

  • exposeHeaders (pulumi.Input[list]) - Specifies expose header in the response.

  • maxAgeSeconds (pulumi.Input[float]) - Specifies time in seconds that browser can cache the response for a preflight request.

The lifecycle_rules object supports the following:

  • enabled (pulumi.Input[bool]) - Specifies lifecycle rule status.

  • expirations (pulumi.Input[list]) - Specifies a period in the object’s expire (documented below).

    • date (pulumi.Input[str]) - Specifies the date after which you want the corresponding action to take effect. The value obeys ISO8601 format like 2017-03-09.

    • days (pulumi.Input[float]) - Specifies the number of days after object creation when the specific rule action takes effect.

  • id (pulumi.Input[str]) - Unique identifier for the rule. If omitted, OSS bucket will assign a unique name.

  • prefix (pulumi.Input[str]) - Object key prefix identifying one or more objects to which the rule applies.

  • transitions (pulumi.Input[list]) - Specifies the time when an object is converted to the IA or archive storage class during a valid life cycle. (documented below).

    • createdBeforeDate (pulumi.Input[str]) - Specifies the time before which the rules take effect. The date must conform to the ISO8601 format and always be UTC 00:00. For example: 2002-10-11T00:00:00.000Z indicates that objects updated before 2002-10-11T00:00:00.000Z are deleted or converted to another storage class, and objects updated after this time (including this time) are not deleted or converted.

    • days (pulumi.Input[float]) - Specifies the number of days after object creation when the specific rule action takes effect.

    • storage_class (pulumi.Input[str]) - Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

The logging object supports the following:

  • targetBucket (pulumi.Input[str]) - The name of the bucket that will receive the log objects.

  • targetPrefix (pulumi.Input[str]) - To specify a key prefix for log objects.

The referer_config object supports the following:

  • allowEmpty (pulumi.Input[bool]) - Allows referer to be empty. Defaults false.

  • referers (pulumi.Input[list]) - The list of referer.

The server_side_encryption_rule object supports the following:

  • sseAlgorithm (pulumi.Input[str]) - The server-side encryption algorithm to use. Possible values: AES256 and KMS.

The versioning object supports the following:

  • status (pulumi.Input[str]) - Specifies the versioning state of a bucket. Valid values: Enabled and Suspended.

The website object supports the following:

  • errorDocument (pulumi.Input[str]) - An absolute path to the document to return in case of a 4XX error.

  • indexDocument (pulumi.Input[str]) - Alicloud OSS returns this index document when requests are made to the root domain or any of the subfolders.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.oss.BucketObject(resource_name, opts=None, acl=None, bucket=None, cache_control=None, content=None, content_disposition=None, content_encoding=None, content_md5=None, content_type=None, expires=None, key=None, kms_key_id=None, server_side_encryption=None, source=None, __props__=None, __name__=None, __opts__=None)

Provides a resource to put a object(content or file) to a oss bucket.

import pulumi
import pulumi_alicloud as alicloud

object_source = alicloud.oss.BucketObject("object-source",
    bucket="your_bucket_name",
    key="new_object_key",
    source="path/to/file")
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.oss.Bucket("example",
    acl="public-read",
    bucket="your_bucket_name")
object_content = alicloud.oss.BucketObject("object-content",
    bucket=example.bucket,
    content="the content that you want to upload.",
    key="new_object_key")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) –

    The canned ACL to apply. Defaults to “private”.

  • bucket (pulumi.Input[str]) – The name of the bucket to put the file in.

  • cache_control (pulumi.Input[str]) – Specifies caching behavior along the request/reply chain. Read RFC2616 Cache-Control for further details.

  • content (pulumi.Input[str]) – The literal content being uploaded to the bucket.

  • content_disposition (pulumi.Input[str]) – Specifies presentational information for the object. Read RFC2616 Content-Disposition for further details.

  • content_encoding (pulumi.Input[str]) – Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read RFC2616 Content-Encoding for further details.

  • content_md5 (pulumi.Input[str]) – The MD5 value of the content. Read MD5 for computing method.

  • content_type (pulumi.Input[str]) – A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.

  • expires (pulumi.Input[str]) – Specifies expire date for the the request/response. Read RFC2616 Expires for further details.

  • key (pulumi.Input[str]) – The name of the object once it is in the bucket.

  • kms_key_id (pulumi.Input[str]) – Specifies the primary key managed by KMS. This parameter is valid when the value of server_side_encryption is set to KMS.

  • server_side_encryption (pulumi.Input[str]) – Specifies server-side encryption of the object in OSS. Valid values are AES256, KMS. Default value is AES256.

  • source (pulumi.Input[str]) – The path to the source file being uploaded to the bucket.

acl: pulumi.Output[str] = None

The canned ACL to apply. Defaults to “private”.

bucket: pulumi.Output[str] = None

The name of the bucket to put the file in.

cache_control: pulumi.Output[str] = None

Specifies caching behavior along the request/reply chain. Read RFC2616 Cache-Control for further details.

content: pulumi.Output[str] = None

The literal content being uploaded to the bucket.

content_disposition: pulumi.Output[str] = None

Specifies presentational information for the object. Read RFC2616 Content-Disposition for further details.

content_encoding: pulumi.Output[str] = None

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read RFC2616 Content-Encoding for further details.

content_length: pulumi.Output[str] = None

the content length of request.

content_md5: pulumi.Output[str] = None

The MD5 value of the content. Read MD5 for computing method.

content_type: pulumi.Output[str] = None

A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.

etag: pulumi.Output[str] = None

the ETag generated for the object (an MD5 sum of the object content).

expires: pulumi.Output[str] = None

Specifies expire date for the the request/response. Read RFC2616 Expires for further details.

key: pulumi.Output[str] = None

The name of the object once it is in the bucket.

kms_key_id: pulumi.Output[str] = None

Specifies the primary key managed by KMS. This parameter is valid when the value of server_side_encryption is set to KMS.

server_side_encryption: pulumi.Output[str] = None

Specifies server-side encryption of the object in OSS. Valid values are AES256, KMS. Default value is AES256.

source: pulumi.Output[str] = None

The path to the source file being uploaded to the bucket.

version_id: pulumi.Output[str] = None

A unique version ID value for the object, if bucket versioning is enabled.

static get(resource_name, id, opts=None, acl=None, bucket=None, cache_control=None, content=None, content_disposition=None, content_encoding=None, content_length=None, content_md5=None, content_type=None, etag=None, expires=None, key=None, kms_key_id=None, server_side_encryption=None, source=None, version_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) –

    The canned ACL to apply. Defaults to “private”.

  • bucket (pulumi.Input[str]) – The name of the bucket to put the file in.

  • cache_control (pulumi.Input[str]) –

    Specifies caching behavior along the request/reply chain. Read RFC2616 Cache-Control for further details.

  • content (pulumi.Input[str]) – The literal content being uploaded to the bucket.

  • content_disposition (pulumi.Input[str]) –

    Specifies presentational information for the object. Read RFC2616 Content-Disposition for further details.

  • content_encoding (pulumi.Input[str]) –

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read RFC2616 Content-Encoding for further details.

  • content_length (pulumi.Input[str]) – the content length of request.

  • content_md5 (pulumi.Input[str]) –

    The MD5 value of the content. Read MD5 for computing method.

  • content_type (pulumi.Input[str]) – A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.

  • etag (pulumi.Input[str]) – the ETag generated for the object (an MD5 sum of the object content).

  • expires (pulumi.Input[str]) –

    Specifies expire date for the the request/response. Read RFC2616 Expires for further details.

  • key (pulumi.Input[str]) – The name of the object once it is in the bucket.

  • kms_key_id (pulumi.Input[str]) – Specifies the primary key managed by KMS. This parameter is valid when the value of server_side_encryption is set to KMS.

  • server_side_encryption (pulumi.Input[str]) – Specifies server-side encryption of the object in OSS. Valid values are AES256, KMS. Default value is AES256.

  • source (pulumi.Input[str]) – The path to the source file being uploaded to the bucket.

  • version_id (pulumi.Input[str]) – A unique version ID value for the object, if bucket versioning is enabled.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.oss.GetBucketObjectsResult(bucket_name=None, id=None, key_prefix=None, key_regex=None, objects=None, output_file=None)

A collection of values returned by getBucketObjects.

id = None

The provider-assigned unique ID for this managed resource.

objects = None

A list of bucket objects. Each element contains the following attributes:

class pulumi_alicloud.oss.GetBucketsResult(buckets=None, id=None, name_regex=None, names=None, output_file=None)

A collection of values returned by getBuckets.

buckets = None

A list of buckets. Each element contains the following attributes:

id = None

The provider-assigned unique ID for this managed resource.

names = None

A list of bucket names.

class pulumi_alicloud.oss.GetInstanceAttachmentsResult(attachments=None, id=None, instance_name=None, name_regex=None, names=None, output_file=None, vpc_ids=None)

A collection of values returned by getInstanceAttachments.

attachments = None

A list of instance attachments. Each element contains the following attributes:

id = None

The provider-assigned unique ID for this managed resource.

instance_name = None

The instance name.

names = None

A list of vpc names.

vpc_ids = None

A list of vpc ids.

class pulumi_alicloud.oss.GetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)

A collection of values returned by getInstances.

id = None

The provider-assigned unique ID for this managed resource.

ids = None

A list of instance IDs.

instances = None

A list of instances. Each element contains the following attributes:

names = None

A list of instance names.

tags = None

The tags of the instance.

class pulumi_alicloud.oss.GetTablesResult(id=None, ids=None, instance_name=None, name_regex=None, names=None, output_file=None, tables=None)

A collection of values returned by getTables.

id = None

The provider-assigned unique ID for this managed resource.

ids = None

A list of table IDs.

instance_name = None

The OTS instance name.

names = None

A list of table names.

tables = None

A list of tables. Each element contains the following attributes:

pulumi_alicloud.oss.get_bucket_objects(bucket_name=None, key_prefix=None, key_regex=None, output_file=None, opts=None)

This data source provides the objects of an OSS bucket.

import pulumi
import pulumi_alicloud as alicloud

bucket_objects_ds = alicloud.oss.get_bucket_objects(bucket_name="sample_bucket",
    key_regex="sample/sample_object.txt")
pulumi.export("firstObjectKey", bucket_objects_ds.objects[0]["key"])
Parameters
  • bucket_name (str) – Name of the bucket that contains the objects to find.

  • key_prefix (str) – Filter results by the given key prefix (such as “path/to/folder/logs-“).

  • key_regex (str) – A regex string to filter results by key.

pulumi_alicloud.oss.get_buckets(name_regex=None, output_file=None, opts=None)

This data source provides the OSS buckets of the current Alibaba Cloud user.

import pulumi
import pulumi_alicloud as alicloud

oss_buckets_ds = alicloud.oss.get_buckets(name_regex="sample_oss_bucket")
pulumi.export("firstOssBucketName", oss_buckets_ds.buckets[0]["name"])
Parameters

name_regex (str) – A regex string to filter results by bucket name.

pulumi_alicloud.oss.get_instance_attachments(instance_name=None, name_regex=None, output_file=None, opts=None)

This data source provides the ots instance attachments of the current Alibaba Cloud user.

import pulumi
import pulumi_alicloud as alicloud

attachments_ds = alicloud.oss.get_instance_attachments(instance_name="sample-instance",
    name_regex="testvpc",
    output_file="attachments.txt")
pulumi.export("firstOtsAttachmentId", attachments_ds.attachments[0]["id"])
Parameters
  • instance_name (str) – The name of OTS instance.

  • name_regex (str) – A regex string to filter results by vpc name.

pulumi_alicloud.oss.get_instances(ids=None, name_regex=None, output_file=None, tags=None, opts=None)

This data source provides the ots instances of the current Alibaba Cloud user.

import pulumi
import pulumi_alicloud as alicloud

instances_ds = alicloud.oss.get_instances(name_regex="sample-instance",
    output_file="instances.txt")
pulumi.export("firstInstanceId", instances_ds.instances[0]["id"])
Parameters
  • ids (list) – A list of instance IDs.

  • name_regex (str) – A regex string to filter results by instance name.

  • tags (dict) – A map of tags assigned to the instance. It must be in the format:

```
data "oss.getInstances" "instances_ds" {
tags = {
tagKey1 = "tagValue1",
tagKey2 = "tagValue2"
}
}
```
pulumi_alicloud.oss.get_tables(ids=None, instance_name=None, name_regex=None, output_file=None, opts=None)

This data source provides the ots tables of the current Alibaba Cloud user.

NOTE: Available in v1.40.0+.

import pulumi
import pulumi_alicloud as alicloud

tables_ds = alicloud.oss.get_tables(instance_name="sample-instance",
    name_regex="sample-table",
    output_file="tables.txt")
pulumi.export("firstTableId", tables_ds.tables[0]["id"])
Parameters
  • ids (list) – A list of table IDs.

  • instance_name (str) – The name of OTS instance.

  • name_regex (str) – A regex string to filter results by table name.