Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. CosBucket
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.CosBucket

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create CosBucket Resource

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

Constructor syntax

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

@overload
def CosBucket(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              bucket_name: Optional[str] = None,
              resource_instance_id: Optional[str] = None,
              cross_region_location: Optional[str] = None,
              metrics_monitoring: Optional[CosBucketMetricsMonitoringArgs] = None,
              allowed_ips: Optional[Sequence[str]] = None,
              cos_bucket_id: Optional[str] = None,
              abort_incomplete_multipart_upload_days: Optional[Sequence[CosBucketAbortIncompleteMultipartUploadDayArgs]] = None,
              endpoint_type: Optional[str] = None,
              expire_rules: Optional[Sequence[CosBucketExpireRuleArgs]] = None,
              force_delete: Optional[bool] = None,
              hard_quota: Optional[float] = None,
              noncurrent_version_expiration: Optional[CosBucketNoncurrentVersionExpirationArgs] = None,
              archive_rule: Optional[CosBucketArchiveRuleArgs] = None,
              kms_key_crn: Optional[str] = None,
              key_protect: Optional[str] = None,
              object_lock: Optional[bool] = None,
              object_versioning: Optional[CosBucketObjectVersioningArgs] = None,
              region_location: Optional[str] = None,
              activity_tracking: Optional[CosBucketActivityTrackingArgs] = None,
              retention_rule: Optional[CosBucketRetentionRuleArgs] = None,
              satellite_location_id: Optional[str] = None,
              single_site_location: Optional[str] = None,
              storage_class: Optional[str] = None,
              timeouts: Optional[CosBucketTimeoutsArgs] = None)
func NewCosBucket(ctx *Context, name string, args CosBucketArgs, opts ...ResourceOption) (*CosBucket, error)
public CosBucket(string name, CosBucketArgs args, CustomResourceOptions? opts = null)
public CosBucket(String name, CosBucketArgs args)
public CosBucket(String name, CosBucketArgs args, CustomResourceOptions options)

type: ibm:CosBucket
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. CosBucketArgs
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. CosBucketArgs
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. CosBucketArgs
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. CosBucketArgs
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. CosBucketArgs
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 cosBucketResource = new Ibm.CosBucket("cosBucketResource", new()
{
    BucketName = "string",
    ResourceInstanceId = "string",
    CrossRegionLocation = "string",
    MetricsMonitoring = new Ibm.Inputs.CosBucketMetricsMonitoringArgs
    {
        MetricsMonitoringCrn = "string",
        RequestMetricsEnabled = false,
        UsageMetricsEnabled = false,
    },
    AllowedIps = new[]
    {
        "string",
    },
    CosBucketId = "string",
    EndpointType = "string",
    ForceDelete = false,
    HardQuota = 0,
    NoncurrentVersionExpiration = new Ibm.Inputs.CosBucketNoncurrentVersionExpirationArgs
    {
        Enable = false,
        NoncurrentDays = 0,
        Prefix = "string",
        RuleId = "string",
    },
    KmsKeyCrn = "string",
    KeyProtect = "string",
    ObjectLock = false,
    ObjectVersioning = new Ibm.Inputs.CosBucketObjectVersioningArgs
    {
        Enable = false,
    },
    RegionLocation = "string",
    ActivityTracking = new Ibm.Inputs.CosBucketActivityTrackingArgs
    {
        ActivityTrackerCrn = "string",
        ManagementEvents = false,
        ReadDataEvents = false,
        WriteDataEvents = false,
    },
    RetentionRule = new Ibm.Inputs.CosBucketRetentionRuleArgs
    {
        Default = 0,
        Maximum = 0,
        Minimum = 0,
        Permanent = false,
    },
    SatelliteLocationId = "string",
    SingleSiteLocation = "string",
    StorageClass = "string",
    Timeouts = new Ibm.Inputs.CosBucketTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewCosBucket(ctx, "cosBucketResource", &ibm.CosBucketArgs{
	BucketName:          pulumi.String("string"),
	ResourceInstanceId:  pulumi.String("string"),
	CrossRegionLocation: pulumi.String("string"),
	MetricsMonitoring: &ibm.CosBucketMetricsMonitoringArgs{
		MetricsMonitoringCrn:  pulumi.String("string"),
		RequestMetricsEnabled: pulumi.Bool(false),
		UsageMetricsEnabled:   pulumi.Bool(false),
	},
	AllowedIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	CosBucketId:  pulumi.String("string"),
	EndpointType: pulumi.String("string"),
	ForceDelete:  pulumi.Bool(false),
	HardQuota:    pulumi.Float64(0),
	NoncurrentVersionExpiration: &ibm.CosBucketNoncurrentVersionExpirationArgs{
		Enable:         pulumi.Bool(false),
		NoncurrentDays: pulumi.Float64(0),
		Prefix:         pulumi.String("string"),
		RuleId:         pulumi.String("string"),
	},
	KmsKeyCrn:  pulumi.String("string"),
	KeyProtect: pulumi.String("string"),
	ObjectLock: pulumi.Bool(false),
	ObjectVersioning: &ibm.CosBucketObjectVersioningArgs{
		Enable: pulumi.Bool(false),
	},
	RegionLocation: pulumi.String("string"),
	ActivityTracking: &ibm.CosBucketActivityTrackingArgs{
		ActivityTrackerCrn: pulumi.String("string"),
		ManagementEvents:   pulumi.Bool(false),
		ReadDataEvents:     pulumi.Bool(false),
		WriteDataEvents:    pulumi.Bool(false),
	},
	RetentionRule: &ibm.CosBucketRetentionRuleArgs{
		Default:   pulumi.Float64(0),
		Maximum:   pulumi.Float64(0),
		Minimum:   pulumi.Float64(0),
		Permanent: pulumi.Bool(false),
	},
	SatelliteLocationId: pulumi.String("string"),
	SingleSiteLocation:  pulumi.String("string"),
	StorageClass:        pulumi.String("string"),
	Timeouts: &ibm.CosBucketTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})
Copy
var cosBucketResource = new CosBucket("cosBucketResource", CosBucketArgs.builder()
    .bucketName("string")
    .resourceInstanceId("string")
    .crossRegionLocation("string")
    .metricsMonitoring(CosBucketMetricsMonitoringArgs.builder()
        .metricsMonitoringCrn("string")
        .requestMetricsEnabled(false)
        .usageMetricsEnabled(false)
        .build())
    .allowedIps("string")
    .cosBucketId("string")
    .endpointType("string")
    .forceDelete(false)
    .hardQuota(0)
    .noncurrentVersionExpiration(CosBucketNoncurrentVersionExpirationArgs.builder()
        .enable(false)
        .noncurrentDays(0)
        .prefix("string")
        .ruleId("string")
        .build())
    .kmsKeyCrn("string")
    .keyProtect("string")
    .objectLock(false)
    .objectVersioning(CosBucketObjectVersioningArgs.builder()
        .enable(false)
        .build())
    .regionLocation("string")
    .activityTracking(CosBucketActivityTrackingArgs.builder()
        .activityTrackerCrn("string")
        .managementEvents(false)
        .readDataEvents(false)
        .writeDataEvents(false)
        .build())
    .retentionRule(CosBucketRetentionRuleArgs.builder()
        .default_(0)
        .maximum(0)
        .minimum(0)
        .permanent(false)
        .build())
    .satelliteLocationId("string")
    .singleSiteLocation("string")
    .storageClass("string")
    .timeouts(CosBucketTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
cos_bucket_resource = ibm.CosBucket("cosBucketResource",
    bucket_name="string",
    resource_instance_id="string",
    cross_region_location="string",
    metrics_monitoring={
        "metrics_monitoring_crn": "string",
        "request_metrics_enabled": False,
        "usage_metrics_enabled": False,
    },
    allowed_ips=["string"],
    cos_bucket_id="string",
    endpoint_type="string",
    force_delete=False,
    hard_quota=0,
    noncurrent_version_expiration={
        "enable": False,
        "noncurrent_days": 0,
        "prefix": "string",
        "rule_id": "string",
    },
    kms_key_crn="string",
    key_protect="string",
    object_lock=False,
    object_versioning={
        "enable": False,
    },
    region_location="string",
    activity_tracking={
        "activity_tracker_crn": "string",
        "management_events": False,
        "read_data_events": False,
        "write_data_events": False,
    },
    retention_rule={
        "default": 0,
        "maximum": 0,
        "minimum": 0,
        "permanent": False,
    },
    satellite_location_id="string",
    single_site_location="string",
    storage_class="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const cosBucketResource = new ibm.CosBucket("cosBucketResource", {
    bucketName: "string",
    resourceInstanceId: "string",
    crossRegionLocation: "string",
    metricsMonitoring: {
        metricsMonitoringCrn: "string",
        requestMetricsEnabled: false,
        usageMetricsEnabled: false,
    },
    allowedIps: ["string"],
    cosBucketId: "string",
    endpointType: "string",
    forceDelete: false,
    hardQuota: 0,
    noncurrentVersionExpiration: {
        enable: false,
        noncurrentDays: 0,
        prefix: "string",
        ruleId: "string",
    },
    kmsKeyCrn: "string",
    keyProtect: "string",
    objectLock: false,
    objectVersioning: {
        enable: false,
    },
    regionLocation: "string",
    activityTracking: {
        activityTrackerCrn: "string",
        managementEvents: false,
        readDataEvents: false,
        writeDataEvents: false,
    },
    retentionRule: {
        "default": 0,
        maximum: 0,
        minimum: 0,
        permanent: false,
    },
    satelliteLocationId: "string",
    singleSiteLocation: "string",
    storageClass: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:CosBucket
properties:
    activityTracking:
        activityTrackerCrn: string
        managementEvents: false
        readDataEvents: false
        writeDataEvents: false
    allowedIps:
        - string
    bucketName: string
    cosBucketId: string
    crossRegionLocation: string
    endpointType: string
    forceDelete: false
    hardQuota: 0
    keyProtect: string
    kmsKeyCrn: string
    metricsMonitoring:
        metricsMonitoringCrn: string
        requestMetricsEnabled: false
        usageMetricsEnabled: false
    noncurrentVersionExpiration:
        enable: false
        noncurrentDays: 0
        prefix: string
        ruleId: string
    objectLock: false
    objectVersioning:
        enable: false
    regionLocation: string
    resourceInstanceId: string
    retentionRule:
        default: 0
        maximum: 0
        minimum: 0
        permanent: false
    satelliteLocationId: string
    singleSiteLocation: string
    storageClass: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

CosBucket 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 CosBucket resource accepts the following input properties:

BucketName This property is required. string
The name of the bucket.
ResourceInstanceId This property is required. string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
AbortIncompleteMultipartUploadDays List<CosBucketAbortIncompleteMultipartUploadDay>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

ActivityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

AllowedIps List<string>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
ArchiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

CosBucketId string
(string) The ID of the bucket.
CrossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
EndpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
ExpireRules List<CosBucketExpireRule>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

ForceDelete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

HardQuota double
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
KeyProtect string
CRN of the key you want to use data at rest encryption
KmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

MetricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

NoncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

ObjectLock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
ObjectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

RegionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
RetentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

SatelliteLocationId string
satellite location id. Provided by end users.
SingleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
StorageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
Timeouts CosBucketTimeouts
BucketName This property is required. string
The name of the bucket.
ResourceInstanceId This property is required. string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
AbortIncompleteMultipartUploadDays []CosBucketAbortIncompleteMultipartUploadDayArgs

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

ActivityTracking CosBucketActivityTrackingArgs

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

AllowedIps []string
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
ArchiveRule CosBucketArchiveRuleArgs

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

CosBucketId string
(string) The ID of the bucket.
CrossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
EndpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
ExpireRules []CosBucketExpireRuleArgs

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

ForceDelete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

HardQuota float64
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
KeyProtect string
CRN of the key you want to use data at rest encryption
KmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

MetricsMonitoring CosBucketMetricsMonitoringArgs

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

NoncurrentVersionExpiration CosBucketNoncurrentVersionExpirationArgs

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

ObjectLock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
ObjectVersioning CosBucketObjectVersioningArgs

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

RegionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
RetentionRule CosBucketRetentionRuleArgs

Nested block have the following structure:

Nested scheme for retention rule:

SatelliteLocationId string
satellite location id. Provided by end users.
SingleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
StorageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
Timeouts CosBucketTimeoutsArgs
bucketName This property is required. String
The name of the bucket.
resourceInstanceId This property is required. String
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
abortIncompleteMultipartUploadDays List<CosBucketAbortIncompleteMultipartUploadDay>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps List<String>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

cosBucketId String
(string) The ID of the bucket.
crossRegionLocation String
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType String
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules List<CosBucketExpireRule>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete Boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota Double
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect String
CRN of the key you want to use data at rest encryption
kmsKeyCrn String

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock Boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation String
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
retentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

satelliteLocationId String
satellite location id. Provided by end users.
singleSiteLocation String
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass String
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeouts
bucketName This property is required. string
The name of the bucket.
resourceInstanceId This property is required. string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
abortIncompleteMultipartUploadDays CosBucketAbortIncompleteMultipartUploadDay[]

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps string[]
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

cosBucketId string
(string) The ID of the bucket.
crossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules CosBucketExpireRule[]

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota number
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect string
CRN of the key you want to use data at rest encryption
kmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
retentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

satelliteLocationId string
satellite location id. Provided by end users.
singleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeouts
bucket_name This property is required. str
The name of the bucket.
resource_instance_id This property is required. str
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
abort_incomplete_multipart_upload_days Sequence[CosBucketAbortIncompleteMultipartUploadDayArgs]

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activity_tracking CosBucketActivityTrackingArgs

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowed_ips Sequence[str]
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archive_rule CosBucketArchiveRuleArgs

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

cos_bucket_id str
(string) The ID of the bucket.
cross_region_location str
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpoint_type str
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expire_rules Sequence[CosBucketExpireRuleArgs]

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

force_delete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hard_quota float
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
key_protect str
CRN of the key you want to use data at rest encryption
kms_key_crn str

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metrics_monitoring CosBucketMetricsMonitoringArgs

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrent_version_expiration CosBucketNoncurrentVersionExpirationArgs

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

object_lock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
object_versioning CosBucketObjectVersioningArgs

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

region_location str
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
retention_rule CosBucketRetentionRuleArgs

Nested block have the following structure:

Nested scheme for retention rule:

satellite_location_id str
satellite location id. Provided by end users.
single_site_location str
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storage_class str
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeoutsArgs
bucketName This property is required. String
The name of the bucket.
resourceInstanceId This property is required. String
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
abortIncompleteMultipartUploadDays List<Property Map>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking Property Map

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps List<String>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule Property Map

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

cosBucketId String
(string) The ID of the bucket.
crossRegionLocation String
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType String
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules List<Property Map>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete Boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota Number
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect String
CRN of the key you want to use data at rest encryption
kmsKeyCrn String

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring Property Map

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration Property Map

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock Boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning Property Map

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation String
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
retentionRule Property Map

Nested block have the following structure:

Nested scheme for retention rule:

satelliteLocationId String
satellite location id. Provided by end users.
singleSiteLocation String
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass String
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts Property Map

Outputs

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

Crn string
(string) The CRN of the bucket.
Id string
The provider-assigned unique ID for this managed resource.
S3EndpointDirect string
(string) Direct endpoint for cos bucket.
S3EndpointPrivate string
(string) Private endpoint for cos bucket.
S3EndpointPublic string
(string) Public endpoint for cos bucket.
Crn string
(string) The CRN of the bucket.
Id string
The provider-assigned unique ID for this managed resource.
S3EndpointDirect string
(string) Direct endpoint for cos bucket.
S3EndpointPrivate string
(string) Private endpoint for cos bucket.
S3EndpointPublic string
(string) Public endpoint for cos bucket.
crn String
(string) The CRN of the bucket.
id String
The provider-assigned unique ID for this managed resource.
s3EndpointDirect String
(string) Direct endpoint for cos bucket.
s3EndpointPrivate String
(string) Private endpoint for cos bucket.
s3EndpointPublic String
(string) Public endpoint for cos bucket.
crn string
(string) The CRN of the bucket.
id string
The provider-assigned unique ID for this managed resource.
s3EndpointDirect string
(string) Direct endpoint for cos bucket.
s3EndpointPrivate string
(string) Private endpoint for cos bucket.
s3EndpointPublic string
(string) Public endpoint for cos bucket.
crn str
(string) The CRN of the bucket.
id str
The provider-assigned unique ID for this managed resource.
s3_endpoint_direct str
(string) Direct endpoint for cos bucket.
s3_endpoint_private str
(string) Private endpoint for cos bucket.
s3_endpoint_public str
(string) Public endpoint for cos bucket.
crn String
(string) The CRN of the bucket.
id String
The provider-assigned unique ID for this managed resource.
s3EndpointDirect String
(string) Direct endpoint for cos bucket.
s3EndpointPrivate String
(string) Private endpoint for cos bucket.
s3EndpointPublic String
(string) Public endpoint for cos bucket.

Look up Existing CosBucket Resource

Get an existing CosBucket 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?: CosBucketState, opts?: CustomResourceOptions): CosBucket
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        abort_incomplete_multipart_upload_days: Optional[Sequence[CosBucketAbortIncompleteMultipartUploadDayArgs]] = None,
        activity_tracking: Optional[CosBucketActivityTrackingArgs] = None,
        allowed_ips: Optional[Sequence[str]] = None,
        archive_rule: Optional[CosBucketArchiveRuleArgs] = None,
        bucket_name: Optional[str] = None,
        cos_bucket_id: Optional[str] = None,
        crn: Optional[str] = None,
        cross_region_location: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        expire_rules: Optional[Sequence[CosBucketExpireRuleArgs]] = None,
        force_delete: Optional[bool] = None,
        hard_quota: Optional[float] = None,
        key_protect: Optional[str] = None,
        kms_key_crn: Optional[str] = None,
        metrics_monitoring: Optional[CosBucketMetricsMonitoringArgs] = None,
        noncurrent_version_expiration: Optional[CosBucketNoncurrentVersionExpirationArgs] = None,
        object_lock: Optional[bool] = None,
        object_versioning: Optional[CosBucketObjectVersioningArgs] = None,
        region_location: Optional[str] = None,
        resource_instance_id: Optional[str] = None,
        retention_rule: Optional[CosBucketRetentionRuleArgs] = None,
        s3_endpoint_direct: Optional[str] = None,
        s3_endpoint_private: Optional[str] = None,
        s3_endpoint_public: Optional[str] = None,
        satellite_location_id: Optional[str] = None,
        single_site_location: Optional[str] = None,
        storage_class: Optional[str] = None,
        timeouts: Optional[CosBucketTimeoutsArgs] = None) -> CosBucket
func GetCosBucket(ctx *Context, name string, id IDInput, state *CosBucketState, opts ...ResourceOption) (*CosBucket, error)
public static CosBucket Get(string name, Input<string> id, CosBucketState? state, CustomResourceOptions? opts = null)
public static CosBucket get(String name, Output<String> id, CosBucketState state, CustomResourceOptions options)
resources:  _:    type: ibm:CosBucket    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:
AbortIncompleteMultipartUploadDays List<CosBucketAbortIncompleteMultipartUploadDay>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

ActivityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

AllowedIps List<string>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
ArchiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

BucketName string
The name of the bucket.
CosBucketId string
(string) The ID of the bucket.
Crn string
(string) The CRN of the bucket.
CrossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
EndpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
ExpireRules List<CosBucketExpireRule>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

ForceDelete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

HardQuota double
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
KeyProtect string
CRN of the key you want to use data at rest encryption
KmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

MetricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

NoncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

ObjectLock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
ObjectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

RegionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
ResourceInstanceId string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
RetentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

S3EndpointDirect string
(string) Direct endpoint for cos bucket.
S3EndpointPrivate string
(string) Private endpoint for cos bucket.
S3EndpointPublic string
(string) Public endpoint for cos bucket.
SatelliteLocationId string
satellite location id. Provided by end users.
SingleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
StorageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
Timeouts CosBucketTimeouts
AbortIncompleteMultipartUploadDays []CosBucketAbortIncompleteMultipartUploadDayArgs

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

ActivityTracking CosBucketActivityTrackingArgs

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

AllowedIps []string
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
ArchiveRule CosBucketArchiveRuleArgs

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

BucketName string
The name of the bucket.
CosBucketId string
(string) The ID of the bucket.
Crn string
(string) The CRN of the bucket.
CrossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
EndpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
ExpireRules []CosBucketExpireRuleArgs

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

ForceDelete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

HardQuota float64
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
KeyProtect string
CRN of the key you want to use data at rest encryption
KmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

MetricsMonitoring CosBucketMetricsMonitoringArgs

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

NoncurrentVersionExpiration CosBucketNoncurrentVersionExpirationArgs

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

ObjectLock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
ObjectVersioning CosBucketObjectVersioningArgs

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

RegionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
ResourceInstanceId string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
RetentionRule CosBucketRetentionRuleArgs

Nested block have the following structure:

Nested scheme for retention rule:

S3EndpointDirect string
(string) Direct endpoint for cos bucket.
S3EndpointPrivate string
(string) Private endpoint for cos bucket.
S3EndpointPublic string
(string) Public endpoint for cos bucket.
SatelliteLocationId string
satellite location id. Provided by end users.
SingleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
StorageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
Timeouts CosBucketTimeoutsArgs
abortIncompleteMultipartUploadDays List<CosBucketAbortIncompleteMultipartUploadDay>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps List<String>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

bucketName String
The name of the bucket.
cosBucketId String
(string) The ID of the bucket.
crn String
(string) The CRN of the bucket.
crossRegionLocation String
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType String
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules List<CosBucketExpireRule>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete Boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota Double
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect String
CRN of the key you want to use data at rest encryption
kmsKeyCrn String

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock Boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation String
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
resourceInstanceId String
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
retentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

s3EndpointDirect String
(string) Direct endpoint for cos bucket.
s3EndpointPrivate String
(string) Private endpoint for cos bucket.
s3EndpointPublic String
(string) Public endpoint for cos bucket.
satelliteLocationId String
satellite location id. Provided by end users.
singleSiteLocation String
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass String
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeouts
abortIncompleteMultipartUploadDays CosBucketAbortIncompleteMultipartUploadDay[]

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking CosBucketActivityTracking

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps string[]
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule CosBucketArchiveRule

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

bucketName string
The name of the bucket.
cosBucketId string
(string) The ID of the bucket.
crn string
(string) The CRN of the bucket.
crossRegionLocation string
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType string
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules CosBucketExpireRule[]

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota number
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect string
CRN of the key you want to use data at rest encryption
kmsKeyCrn string

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring CosBucketMetricsMonitoring

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration CosBucketNoncurrentVersionExpiration

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning CosBucketObjectVersioning

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation string
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
resourceInstanceId string
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
retentionRule CosBucketRetentionRule

Nested block have the following structure:

Nested scheme for retention rule:

s3EndpointDirect string
(string) Direct endpoint for cos bucket.
s3EndpointPrivate string
(string) Private endpoint for cos bucket.
s3EndpointPublic string
(string) Public endpoint for cos bucket.
satelliteLocationId string
satellite location id. Provided by end users.
singleSiteLocation string
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass string
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeouts
abort_incomplete_multipart_upload_days Sequence[CosBucketAbortIncompleteMultipartUploadDayArgs]

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activity_tracking CosBucketActivityTrackingArgs

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowed_ips Sequence[str]
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archive_rule CosBucketArchiveRuleArgs

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

bucket_name str
The name of the bucket.
cos_bucket_id str
(string) The ID of the bucket.
crn str
(string) The CRN of the bucket.
cross_region_location str
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpoint_type str
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expire_rules Sequence[CosBucketExpireRuleArgs]

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

force_delete bool

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hard_quota float
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
key_protect str
CRN of the key you want to use data at rest encryption
kms_key_crn str

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metrics_monitoring CosBucketMetricsMonitoringArgs

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrent_version_expiration CosBucketNoncurrentVersionExpirationArgs

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

object_lock bool

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
object_versioning CosBucketObjectVersioningArgs

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

region_location str
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
resource_instance_id str
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
retention_rule CosBucketRetentionRuleArgs

Nested block have the following structure:

Nested scheme for retention rule:

s3_endpoint_direct str
(string) Direct endpoint for cos bucket.
s3_endpoint_private str
(string) Private endpoint for cos bucket.
s3_endpoint_public str
(string) Public endpoint for cos bucket.
satellite_location_id str
satellite location id. Provided by end users.
single_site_location str
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storage_class str
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts CosBucketTimeoutsArgs
abortIncompleteMultipartUploadDays List<Property Map>

Nested block with the following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of abort_incomplete_multipart_upload_days to manage the lifecycle abort incomplete multipart upload days on cos bucket.

Nested scheme for abort_incomplete_multipart_upload_days:

Deprecated: Deprecated

activityTracking Property Map

Enables sending log data to IBM Cloud Activity Tracker to provide visibility into bucket management, object read and write events.

(Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance at the container's location unless otherwise specified in the ATracker Routing service configuration.

(Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified.

For more information please follow ,IBM Cloud Activity Tracker.For a list of supported actions, see Bucket actions.

Nested scheme for activity_tracking:

allowedIps List<String>
A list of IPv4 or IPv6 addresses in CIDR notation that you want to allow access to your IBM Cloud Object Storage bucket.
archiveRule Property Map

Nested archive_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of archive rule to manage the lifecycle archive rule on cos bucket.

Nested scheme for archive_rule:

Deprecated: Deprecated

bucketName String
The name of the bucket.
cosBucketId String
(string) The ID of the bucket.
crn String
(string) The CRN of the bucket.
crossRegionLocation String
Specify the cross-regional bucket location. Supported values are us, eu, and ap. If you use this parameter, do not set single_site_location or region_location at the same time.
endpointType String
The type of the endpoint either public or private or direct to be used for buckets. Default value is public.
expireRules List<Property Map>

An expiration rule deletes objects after a defined period (from the object creation date). see lifecycle actions. Nested expire_rule block has following structure.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of expire_rule to manage the lifecycle expire rule on cos bucket. Nested scheme for expire_rule:

Deprecated: Deprecated

forceDelete Boolean

As the default value set to true, it will delete all the objects in the COS Bucket and then delete the bucket.

Note: force_delete will timeout on buckets with a large amount of objects. 24 hours before you delete the bucket you can set an expire rule to remove all the files over a day old.

hardQuota Number
Sets a maximum amount of storage (in bytes) available for a bucket. For more information, check the cloud documention.
keyProtect String
CRN of the key you want to use data at rest encryption
kmsKeyCrn String

The CRN of the IBM Key Protect root key that you want to use to encrypt data that is sent and stored in IBM Cloud Object Storage. Before you can enable IBM Key Protect encryption, you must provision an instance of IBM Key Protect and authorize the service to access IBM Cloud Object Storage. For more information, see Server-Side Encryption with IBM Key Protect or Hyper Protect Crypto Services (SSE-KP). Note:

key_protect attribute has been renamed as kms_key_crn , hence it is recommended to all the new users to use kms_key_crn.Although the support for older attribute name key_protect will be continued for existing customers.

metricsMonitoring Property Map

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in.

(Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration.

(Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field. For more details check the IBM Cloud Monitoring.

Nested scheme for metrics_monitoring:

noncurrentVersionExpiration Property Map

lifecycle has a versioning related expiration action: non-current version expiration. This can remove old versions of objects after they've been non-current for a specified number of days which is specified with a NoncurrentDays parameter on the rule. see lifecycle actions.

(Recommended) Use ibm.CosBucketLifecycleConfiguration instead of noncurrent_version_expiration to manage the lifecycle noncurrent version expiration on cos bucket.

Nested noncurrent_version_expiration block has following structure.

Nested scheme for noncurrent_version_expiration:

objectLock Boolean

Enables Object Lock feature on a COS bucket.

Note:

  • To enable Object Lock on a bucket , object_versioning should be enabled.
objectVersioning Property Map

Object Versioning allows the COS user to keep multiple versions of an object in a bucket to protect against accidental deletion or overwrites. With versioning, you can easily recover from both unintended user actions and application failure. Nested block have the following structure:

Nested scheme for object_versioning:

regionLocation String
The location of a regional bucket. Supported values are au-syd, eu-de, eu-gb, jp-tok, us-east, us-south, ca-tor, jp-osa, br-sao. If you set this parameter, do not set single_site_location or cross_region_location at the same time.
resourceInstanceId String
The ID of the IBM Cloud Object Storage service instance for which you want to create a bucket.
retentionRule Property Map

Nested block have the following structure:

Nested scheme for retention rule:

s3EndpointDirect String
(string) Direct endpoint for cos bucket.
s3EndpointPrivate String
(string) Private endpoint for cos bucket.
s3EndpointPublic String
(string) Public endpoint for cos bucket.
satelliteLocationId String
satellite location id. Provided by end users.
singleSiteLocation String
The location for a single site bucket. Supported values are: ams03, che01, hkg02, mel01, mex01, mil01, mon01, osl01, par01, sjc04, sao01, seo01, sng01, and tor01. If you set this parameter, do not set region_location or cross_region_location at the same time.
storageClass String
The storage class that you want to use for the bucket. Supported values are standard, vault, cold and smart for standard and lite COS plans, onerate_active for cos-one-rate-plan COS plan.For more information, about storage classes, see Use storage classes.storage_class should not be used with Satellite location id.
timeouts Property Map

Supporting Types

CosBucketAbortIncompleteMultipartUploadDay
, CosBucketAbortIncompleteMultipartUploadDayArgs

Enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
DaysAfterInitiation double
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
Prefix string
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
RuleId string
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.
Enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
DaysAfterInitiation float64
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
Prefix string
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
RuleId string
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.
enable This property is required. Boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
daysAfterInitiation Double
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
prefix String
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId String
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.
enable This property is required. boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
daysAfterInitiation number
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
prefix string
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId string
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.
enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
days_after_initiation float
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
prefix str
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
rule_id str
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.
enable This property is required. Boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
daysAfterInitiation Number
Specifies the number of days that govern the automatic cancellation of part upload. Clean up incomplete multi-part uploads after a period of time. Must be a value greater than 0 and less than 3650.
prefix String
A rule with a prefix will only apply to the objects that match. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId String
Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket.

CosBucketActivityTracking
, CosBucketActivityTrackingArgs

ActivityTrackerCrn string
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
ManagementEvents bool
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
ReadDataEvents bool
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
WriteDataEvents bool
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.
ActivityTrackerCrn string
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
ManagementEvents bool
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
ReadDataEvents bool
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
WriteDataEvents bool
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.
activityTrackerCrn String
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
managementEvents Boolean
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
readDataEvents Boolean
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
writeDataEvents Boolean
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.
activityTrackerCrn string
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
managementEvents boolean
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
readDataEvents boolean
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
writeDataEvents boolean
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.
activity_tracker_crn str
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
management_events bool
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
read_data_events bool
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
write_data_events bool
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.
activityTrackerCrn String
When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker instance associated to the container's location unless otherwise specified in the Activity Tracker Event Routing service configuration.If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker instance specified and bucket management events are always enabled.
managementEvents Boolean
If set to true, all bucket management events will be sent to Activity Tracker.This field only applies if activity_tracker_crn is not populated.
readDataEvents Boolean
If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker.
writeDataEvents Boolean
If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker.

CosBucketArchiveRule
, CosBucketArchiveRuleArgs

Days This property is required. double
Specifies the number of days when the specific rule action takes effect.
Enable This property is required. bool
Specifies archive rule status either enable or disable for a bucket.
Type This property is required. string

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
RuleId string
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.
Days This property is required. float64
Specifies the number of days when the specific rule action takes effect.
Enable This property is required. bool
Specifies archive rule status either enable or disable for a bucket.
Type This property is required. string

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
RuleId string
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.
days This property is required. Double
Specifies the number of days when the specific rule action takes effect.
enable This property is required. Boolean
Specifies archive rule status either enable or disable for a bucket.
type This property is required. String

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
ruleId String
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.
days This property is required. number
Specifies the number of days when the specific rule action takes effect.
enable This property is required. boolean
Specifies archive rule status either enable or disable for a bucket.
type This property is required. string

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
ruleId string
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.
days This property is required. float
Specifies the number of days when the specific rule action takes effect.
enable This property is required. bool
Specifies archive rule status either enable or disable for a bucket.
type This property is required. str

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
rule_id str
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.
days This property is required. Number
Specifies the number of days when the specific rule action takes effect.
enable This property is required. Boolean
Specifies archive rule status either enable or disable for a bucket.
type This property is required. String

Specifies the storage class or archive type to which you want the object to transition. Allowed values are Glacier or Accelerated.

Note:

  • Archive is available in certain regions only. For more information, see Integrated Services.
  • Restoring object once archive is not supported yet.
ruleId String
The unique ID for the rule. Archive rules allow you to set a specific time frame after the objects transition to the archive.

CosBucketExpireRule
, CosBucketExpireRuleArgs

Enable This property is required. bool
Specifies expire rule status either enable or disable for a bucket.
Date string
After the specifies date , the current version of objects in your bucket expires.
Days double
Specifies the number of days when the specific rule action takes effect.
ExpiredObjectDeleteMarker bool
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
Prefix string
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
RuleId string
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket
Enable This property is required. bool
Specifies expire rule status either enable or disable for a bucket.
Date string
After the specifies date , the current version of objects in your bucket expires.
Days float64
Specifies the number of days when the specific rule action takes effect.
ExpiredObjectDeleteMarker bool
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
Prefix string
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
RuleId string
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket
enable This property is required. Boolean
Specifies expire rule status either enable or disable for a bucket.
date String
After the specifies date , the current version of objects in your bucket expires.
days Double
Specifies the number of days when the specific rule action takes effect.
expiredObjectDeleteMarker Boolean
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
prefix String
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
ruleId String
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket
enable This property is required. boolean
Specifies expire rule status either enable or disable for a bucket.
date string
After the specifies date , the current version of objects in your bucket expires.
days number
Specifies the number of days when the specific rule action takes effect.
expiredObjectDeleteMarker boolean
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
prefix string
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
ruleId string
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket
enable This property is required. bool
Specifies expire rule status either enable or disable for a bucket.
date str
After the specifies date , the current version of objects in your bucket expires.
days float
Specifies the number of days when the specific rule action takes effect.
expired_object_delete_marker bool
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
prefix str
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
rule_id str
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket
enable This property is required. Boolean
Specifies expire rule status either enable or disable for a bucket.
date String
After the specifies date , the current version of objects in your bucket expires.
days Number
Specifies the number of days when the specific rule action takes effect.
expiredObjectDeleteMarker Boolean
Expired object delete markers can be automatically cleaned up to improve performance in your bucket. This cannot be used alongside version expiration. This element for the Expiration action which will only remove delete markers that have no non-current versions at all & objects whose only version is a single delete marker.
prefix String
Specifies a prefix filter to apply to only a subset of objects with names that match the prefix.
ruleId String
Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket

CosBucketMetricsMonitoring
, CosBucketMetricsMonitoringArgs

MetricsMonitoringCrn string
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
RequestMetricsEnabled bool
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
UsageMetricsEnabled bool
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
MetricsMonitoringCrn string
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
RequestMetricsEnabled bool
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
UsageMetricsEnabled bool
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
metricsMonitoringCrn String
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
requestMetricsEnabled Boolean
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
usageMetricsEnabled Boolean
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
metricsMonitoringCrn string
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
requestMetricsEnabled boolean
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
usageMetricsEnabled boolean
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
metrics_monitoring_crn str
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
request_metrics_enabled bool
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
usage_metrics_enabled bool
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
metricsMonitoringCrn String
When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration.If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified(Legacy).
requestMetricsEnabled Boolean
If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
usageMetricsEnabled Boolean
If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.

CosBucketNoncurrentVersionExpiration
, CosBucketNoncurrentVersionExpirationArgs

Enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
NoncurrentDays double
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
Prefix string
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
RuleId string
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.
Enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
NoncurrentDays float64
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
Prefix string
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
RuleId string
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.
enable This property is required. Boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
noncurrentDays Double
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
prefix String
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId String
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.
enable This property is required. boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
noncurrentDays number
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
prefix string
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId string
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.
enable This property is required. bool
A rule can either be enabled or disabled. A rule is active only when enabled.
noncurrent_days float
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
prefix str
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
rule_id str
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.
enable This property is required. Boolean
A rule can either be enabled or disabled. A rule is active only when enabled.
noncurrentDays Number
Configuration parameter in your policy that says how long to retain a non-current version before deleting it. Must be greater than 0.
prefix String
The rule applies to any objects with keys that match this prefix. You can use multiple rules for different actions for different prefixes within the same bucket.
ruleId String
Unique identifier for the rule. Rules allow you to remove versions from objects. Set Rule ID for cos bucket.

CosBucketObjectVersioning
, CosBucketObjectVersioningArgs

Enable bool

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.
Enable bool

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.
enable Boolean

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.
enable boolean

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.
enable bool

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.
enable Boolean

Specifies Versioning status either enable or Suspended for the objects in the bucket.Default value set to false.

Note:

  • Versioning allows multiple revisions of a single object to exist in the same bucket. Each version of an object can be queried, read, restored from an archived state, or deleted.
  • If cos bucket has versioning enabled and set to false, versioning will be suspended.
  • Versioning can only be suspended, we cannot disabled once after it is enabled.
  • To permanently delete individual versions of an object, a delete request must specify a version ID.
  • COS Object versioning and COS Bucket Protection (WORM) cannot be used together.
  • Containers with proxy configuration cannot use versioning and vice versa.
  • SoftLayer accounts cannot use versioning.
  • Currently, you cannot support MFA_Delete, that is a feature to add additional security to version delete.

CosBucketRetentionRule
, CosBucketRetentionRuleArgs

Default This property is required. double
default retention period are defined by this policy and apply to all objects in the bucket.
Maximum This property is required. double
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
Minimum This property is required. double
Specifies minimum duration of time an object must be kept unmodified in the bucket.
Permanent bool

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.
Default This property is required. float64
default retention period are defined by this policy and apply to all objects in the bucket.
Maximum This property is required. float64
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
Minimum This property is required. float64
Specifies minimum duration of time an object must be kept unmodified in the bucket.
Permanent bool

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.
default_ This property is required. Double
default retention period are defined by this policy and apply to all objects in the bucket.
maximum This property is required. Double
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
minimum This property is required. Double
Specifies minimum duration of time an object must be kept unmodified in the bucket.
permanent Boolean

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.
default This property is required. number
default retention period are defined by this policy and apply to all objects in the bucket.
maximum This property is required. number
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
minimum This property is required. number
Specifies minimum duration of time an object must be kept unmodified in the bucket.
permanent boolean

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.
default This property is required. float
default retention period are defined by this policy and apply to all objects in the bucket.
maximum This property is required. float
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
minimum This property is required. float
Specifies minimum duration of time an object must be kept unmodified in the bucket.
permanent bool

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.
default This property is required. Number
default retention period are defined by this policy and apply to all objects in the bucket.
maximum This property is required. Number
Specifies maximum duration of time an object that can be kept unmodified in the bucket.
minimum This property is required. Number
Specifies minimum duration of time an object must be kept unmodified in the bucket.
permanent Boolean

Specifies a permanent retention status either enable or disable for a bucket.

Note:

  • Retention policies cannot be removed. For a new bucket, ensure that you are creating the bucket in a supported region. For more information, see Integrated Services.
  • The minimum retention period must be less than or equal to the default retention period, that in turn must be less than or equal to the maximum retention period.
  • Permanent retention can only be enabled at a IBM Cloud Object Storage bucket level with retention policy enabled and users are able to select the permanent retention period option during object uploads. Once enabled, this process can't be reversed and objects uploaded that use a permanent retention period cannot be deleted. It's the responsibility of the users to validate at their end if there's a legitimate need to permanently store objects by using Object Storage buckets with a retention policy.
  • force deleting the bucket will not work if any object is still under retention. As objects cannot be deleted or overwritten until the retention period has expired and all the legal holds have been removed.

CosBucketTimeouts
, CosBucketTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm