Package-level declarations

Types

Link copied to clipboard

Creates a new bucket in Google cloud storage service (GCS). Once a bucket has been created, its location can't be changed. For more information see the official documentation and API. Note: If the project id is not set on the resource or in the provider block it will be dynamically determined which will require enabling the compute api.

Link copied to clipboard

BucketAccessControl can be imported using any of these accepted formats

Link copied to clipboard
data class BucketAccessControlArgs(val bucket: Output<String>? = null, val entity: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<BucketAccessControlArgs>

BucketAccessControl can be imported using any of these accepted formats

Link copied to clipboard

Example creating an ACL on a bucket with one owner, and one reader.

Link copied to clipboard
data class BucketACLArgs(val bucket: Output<String>? = null, val defaultAcl: Output<String>? = null, val predefinedAcl: Output<String>? = null, val roleEntities: Output<List<String>>? = null) : ConvertibleToJava<BucketACLArgs>

Example creating an ACL on a bucket with one owner, and one reader.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class BucketArgs(val autoclass: Output<BucketAutoclassArgs>? = null, val cors: Output<List<BucketCorArgs>>? = null, val customPlacementConfig: Output<BucketCustomPlacementConfigArgs>? = null, val defaultEventBasedHold: Output<Boolean>? = null, val encryption: Output<BucketEncryptionArgs>? = null, val forceDestroy: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val lifecycleRules: Output<List<BucketLifecycleRuleArgs>>? = null, val location: Output<String>? = null, val logging: Output<BucketLoggingArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val publicAccessPrevention: Output<String>? = null, val requesterPays: Output<Boolean>? = null, val retentionPolicy: Output<BucketRetentionPolicyArgs>? = null, val storageClass: Output<String>? = null, val uniformBucketLevelAccess: Output<Boolean>? = null, val versioning: Output<BucketVersioningArgs>? = null, val website: Output<BucketWebsiteArgs>? = null) : ConvertibleToJava<BucketArgs>

Creates a new bucket in Google cloud storage service (GCS). Once a bucket has been created, its location can't be changed. For more information see the official documentation and API. Note: If the project id is not set on the resource or in the provider block it will be dynamically determined which will require enabling the compute api.

Link copied to clipboard

Builder for BucketArgs.

Link copied to clipboard

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard
data class BucketIAMBindingArgs(val bucket: Output<String>? = null, val condition: Output<BucketIAMBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val role: Output<String>? = null) : ConvertibleToJava<BucketIAMBindingArgs>

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard
data class BucketIAMMemberArgs(val bucket: Output<String>? = null, val condition: Output<BucketIAMMemberConditionArgs>? = null, val member: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<BucketIAMMemberArgs>

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard
data class BucketIAMPolicyArgs(val bucket: Output<String>? = null, val policyData: Output<String>? = null) : ConvertibleToJava<BucketIAMPolicyArgs>

Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard

Creates a new object inside an existing bucket in Google cloud storage service (GCS). ACLs can be applied using the gcp.storage.ObjectACL resource. For more information see the official documentation and API.

Link copied to clipboard
data class BucketObjectArgs(val bucket: Output<String>? = null, val cacheControl: Output<String>? = null, val content: Output<String>? = null, val contentDisposition: Output<String>? = null, val contentEncoding: Output<String>? = null, val contentLanguage: Output<String>? = null, val contentType: Output<String>? = null, val customerEncryption: Output<BucketObjectCustomerEncryptionArgs>? = null, val detectMd5hash: Output<String>? = null, val eventBasedHold: Output<Boolean>? = null, val kmsKeyName: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val name: Output<String>? = null, val source: Output<AssetOrArchive>? = null, val storageClass: Output<String>? = null, val temporaryHold: Output<Boolean>? = null) : ConvertibleToJava<BucketObjectArgs>

Creates a new object inside an existing bucket in Google cloud storage service (GCS). ACLs can be applied using the gcp.storage.ObjectACL resource. For more information see the official documentation and API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Builder for Bucket.

Link copied to clipboard

The DefaultObjectAccessControls resources represent the Access Control Lists (ACLs) applied to a new object within a Google Cloud Storage bucket when no ACL was provided for that object. ACLs let you specify who has access to your bucket contents and to what extent. There are two roles that can be assigned to an entity: READERs can get an object, though the acl property will not be revealed. OWNERs are READERs, and they can get the acl property, update an object, and call all objectAccessControls methods on the object. The owner of an object is always an OWNER. For more information, see Access Control, with the caveat that this API uses READER and OWNER instead of READ and FULL_CONTROL. To get more information about DefaultObjectAccessControl, see:

Link copied to clipboard
data class DefaultObjectAccessControlArgs(val bucket: Output<String>? = null, val entity: Output<String>? = null, val object: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<DefaultObjectAccessControlArgs>

The DefaultObjectAccessControls resources represent the Access Control Lists (ACLs) applied to a new object within a Google Cloud Storage bucket when no ACL was provided for that object. ACLs let you specify who has access to your bucket contents and to what extent. There are two roles that can be assigned to an entity: READERs can get an object, though the acl property will not be revealed. OWNERs are READERs, and they can get the acl property, update an object, and call all objectAccessControls methods on the object. The owner of an object is always an OWNER. For more information, see Access Control, with the caveat that this API uses READER and OWNER instead of READ and FULL_CONTROL. To get more information about DefaultObjectAccessControl, see:

Link copied to clipboard

Authoritatively manages the default object ACLs for a Google Cloud Storage bucket without managing the bucket itself.

Link copied to clipboard
data class DefaultObjectACLArgs(val bucket: Output<String>? = null, val roleEntities: Output<List<String>>? = null) : ConvertibleToJava<DefaultObjectACLArgs>

Authoritatively manages the default object ACLs for a Google Cloud Storage bucket without managing the bucket itself.

Link copied to clipboard

HmacKey can be imported using any of these accepted formats

Link copied to clipboard
data class HmacKeyArgs(val project: Output<String>? = null, val serviceAccountEmail: Output<String>? = null, val state: Output<String>? = null) : ConvertibleToJava<HmacKeyArgs>

HmacKey can be imported using any of these accepted formats

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Creates a new notification configuration on a specified bucket, establishing a flow of event notifications from GCS to a Cloud Pub/Sub topic. For more information see the official documentation and API. In order to enable notifications, a special Google Cloud Storage service account unique to the project must exist and have the IAM permission "projects.topics.publish" for a Cloud Pub/Sub topic in the project. This service account is not created automatically when a project is created. To ensure the service account exists and obtain its email address for use in granting the correct IAM permission, use the gcp&#46;storage&#46;getProjectServiceAccount datasource's email_address value, and see below for an example of enabling notifications by granting the correct IAM permission. See the notifications documentation for more details.

Link copied to clipboard
data class NotificationArgs(val bucket: Output<String>? = null, val customAttributes: Output<Map<String, String>>? = null, val eventTypes: Output<List<String>>? = null, val objectNamePrefix: Output<String>? = null, val payloadFormat: Output<String>? = null, val topic: Output<String>? = null) : ConvertibleToJava<NotificationArgs>

Creates a new notification configuration on a specified bucket, establishing a flow of event notifications from GCS to a Cloud Pub/Sub topic. For more information see the official documentation and API. In order to enable notifications, a special Google Cloud Storage service account unique to the project must exist and have the IAM permission "projects.topics.publish" for a Cloud Pub/Sub topic in the project. This service account is not created automatically when a project is created. To ensure the service account exists and obtain its email address for use in granting the correct IAM permission, use the gcp&#46;storage&#46;getProjectServiceAccount datasource's email_address value, and see below for an example of enabling notifications by granting the correct IAM permission. See the notifications documentation for more details.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The ObjectAccessControls resources represent the Access Control Lists (ACLs) for objects within Google Cloud Storage. ACLs let you specify who has access to your data and to what extent. There are two roles that can be assigned to an entity: READERs can get an object, though the acl property will not be revealed. OWNERs are READERs, and they can get the acl property, update an object, and call all objectAccessControls methods on the object. The owner of an object is always an OWNER. For more information, see Access Control, with the caveat that this API uses READER and OWNER instead of READ and FULL_CONTROL. To get more information about ObjectAccessControl, see:

Link copied to clipboard
data class ObjectAccessControlArgs(val bucket: Output<String>? = null, val entity: Output<String>? = null, val object: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ObjectAccessControlArgs>

The ObjectAccessControls resources represent the Access Control Lists (ACLs) for objects within Google Cloud Storage. ACLs let you specify who has access to your data and to what extent. There are two roles that can be assigned to an entity: READERs can get an object, though the acl property will not be revealed. OWNERs are READERs, and they can get the acl property, update an object, and call all objectAccessControls methods on the object. The owner of an object is always an OWNER. For more information, see Access Control, with the caveat that this API uses READER and OWNER instead of READ and FULL_CONTROL. To get more information about ObjectAccessControl, see:

Link copied to clipboard

Authoritatively manages the access control list (ACL) for an object in a Google Cloud Storage (GCS) bucket. Removing a gcp.storage.ObjectACL sets the acl to the private predefined ACL. For more information see the official documentation and API.

Link copied to clipboard
data class ObjectACLArgs(val bucket: Output<String>? = null, val object: Output<String>? = null, val predefinedAcl: Output<String>? = null, val roleEntities: Output<List<String>>? = null) : ConvertibleToJava<ObjectACLArgs>

Authoritatively manages the access control list (ACL) for an object in a Google Cloud Storage (GCS) bucket. Removing a gcp.storage.ObjectACL sets the acl to the private predefined ACL. For more information see the official documentation and API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents an On-Premises Agent pool. To get more information about AgentPool, see:

Link copied to clipboard
data class TransferAgentPoolArgs(val bandwidthLimit: Output<TransferAgentPoolBandwidthLimitArgs>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<TransferAgentPoolArgs>

Represents an On-Premises Agent pool. To get more information about AgentPool, see:

Link copied to clipboard

Creates a new Transfer Job in Google Cloud Storage Transfer. To get more information about Google Cloud Storage Transfer, see:

Link copied to clipboard
data class TransferJobArgs(val description: Output<String>? = null, val notificationConfig: Output<TransferJobNotificationConfigArgs>? = null, val project: Output<String>? = null, val schedule: Output<TransferJobScheduleArgs>? = null, val status: Output<String>? = null, val transferSpec: Output<TransferJobTransferSpecArgs>? = null) : ConvertibleToJava<TransferJobArgs>

Creates a new Transfer Job in Google Cloud Storage Transfer. To get more information about Google Cloud Storage Transfer, see:

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun bucketACLResource(name: String, block: suspend BucketACLResourceBuilder.() -> Unit): BucketACL
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun bucketObjectResource(name: String, block: suspend BucketObjectResourceBuilder.() -> Unit): BucketObject
Link copied to clipboard
suspend fun bucketResource(name: String, block: suspend BucketResourceBuilder.() -> Unit): Bucket
Link copied to clipboard
Link copied to clipboard
suspend fun hmacKeyResource(name: String, block: suspend HmacKeyResourceBuilder.() -> Unit): HmacKey
Link copied to clipboard
suspend fun notificationResource(name: String, block: suspend NotificationResourceBuilder.() -> Unit): Notification
Link copied to clipboard
suspend fun objectACLResource(name: String, block: suspend ObjectACLResourceBuilder.() -> Unit): ObjectACL
Link copied to clipboard
Link copied to clipboard
suspend fun transferJobResource(name: String, block: suspend TransferJobResourceBuilder.() -> Unit): TransferJob