BackendBucket

Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing.

An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content to a virtual machine instance.

To get more information about BackendBucket, see:

API documentation
How-to Guides
- Using a Cloud Storage bucket as a load balancer backend

Create a BackendBucket Resource

new BackendBucket(name: string, args: BackendBucketArgs, opts?: CustomResourceOptions);

def BackendBucket(resource_name, opts=None, bucket_name=None, cdn_policy=None, description=None, enable_cdn=None, name=None, project=None, __props__=None);

func NewBackendBucket(ctx *Context, name string, args BackendBucketArgs, opts ...ResourceOption) (*BackendBucket, error)

public BackendBucket(string name, BackendBucketArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args BackendBucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BackendBucketArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackendBucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

BackendBucket Resource Properties

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

Inputs

The BackendBucket resource accepts the following input properties:

BucketName string: Cloud Storage bucket name.
CdnPolicy BackendBucketCdnPolicyArgs: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
Description string: An optional textual description of the resource; provided by the client when the resource is created.
EnableCdn bool: If true, enable Cloud CDN for this BackendBucket.
Name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

BucketName string: Cloud Storage bucket name.
CdnPolicy BackendBucketCdnPolicy: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
Description string: An optional textual description of the resource; provided by the client when the resource is created.
EnableCdn bool: If true, enable Cloud CDN for this BackendBucket.
Name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

bucketName string: Cloud Storage bucket name.
cdnPolicy BackendBucketCdnPolicy: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
description string: An optional textual description of the resource; provided by the client when the resource is created.
enableCdn boolean: If true, enable Cloud CDN for this BackendBucket.
name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

bucket_name str: Cloud Storage bucket name.
cdn_policy Dict[BackendBucketCdnPolicy]: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
description str: An optional textual description of the resource; provided by the client when the resource is created.
enable_cdn bool: If true, enable Cloud CDN for this BackendBucket.
name str: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

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

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing BackendBucket Resource

Get an existing BackendBucket 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?: BackendBucketState, opts?: CustomResourceOptions): BackendBucket

static get(resource_name, id, opts=None, bucket_name=None, cdn_policy=None, creation_timestamp=None, description=None, enable_cdn=None, name=None, project=None, self_link=None, __props__=None);

func GetBackendBucket(ctx *Context, name string, id IDInput, state *BackendBucketState, opts ...ResourceOption) (*BackendBucket, error)

public static BackendBucket Get(string name, Input<string> id, BackendBucketState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BucketName string: Cloud Storage bucket name.
CdnPolicy BackendBucketCdnPolicyArgs: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource; provided by the client when the resource is created.
EnableCdn bool: If true, enable Cloud CDN for this BackendBucket.
Name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.

BucketName string: Cloud Storage bucket name.
CdnPolicy BackendBucketCdnPolicy: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource; provided by the client when the resource is created.
EnableCdn bool: If true, enable Cloud CDN for this BackendBucket.
Name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.

bucketName string: Cloud Storage bucket name.
cdnPolicy BackendBucketCdnPolicy: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional textual description of the resource; provided by the client when the resource is created.
enableCdn boolean: If true, enable Cloud CDN for this BackendBucket.
name string: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.

bucket_name str: Cloud Storage bucket name.
cdn_policy Dict[BackendBucketCdnPolicy]: Cloud CDN configuration for this Backend Bucket. Structure is documented below.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional textual description of the resource; provided by the client when the resource is created.
enable_cdn bool: If true, enable Cloud CDN for this BackendBucket.
name str: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.

Supporting Types

BackendBucketCdnPolicy

See the input and output API doc for this type.

SignedUrlCacheMaxAgeSec int: Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

SignedUrlCacheMaxAgeSec int: Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

signedUrlCacheMaxAgeSec number: Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

signedUrlCacheMaxAgeSec float: Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud