gcp.cloudtasks.Queue
Explore with Pulumi AI
A named resource to which messages are sent by publishers.
Example Usage
Queue Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.cloudtasks.Queue("default", {
name: "cloud-tasks-queue-test",
location: "us-central1",
});
import pulumi
import pulumi_gcp as gcp
default = gcp.cloudtasks.Queue("default",
name="cloud-tasks-queue-test",
location="us-central1")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudtasks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudtasks.NewQueue(ctx, "default", &cloudtasks.QueueArgs{
Name: pulumi.String("cloud-tasks-queue-test"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.CloudTasks.Queue("default", new()
{
Name = "cloud-tasks-queue-test",
Location = "us-central1",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudtasks.Queue;
import com.pulumi.gcp.cloudtasks.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new Queue("default", QueueArgs.builder()
.name("cloud-tasks-queue-test")
.location("us-central1")
.build());
}
}
resources:
default:
type: gcp:cloudtasks:Queue
properties:
name: cloud-tasks-queue-test
location: us-central1
Cloud Tasks Queue Advanced
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const advancedConfiguration = new gcp.cloudtasks.Queue("advanced_configuration", {
name: "instance-name",
location: "us-central1",
appEngineRoutingOverride: {
service: "worker",
version: "1.0",
instance: "test",
},
rateLimits: {
maxConcurrentDispatches: 3,
maxDispatchesPerSecond: 2,
},
retryConfig: {
maxAttempts: 5,
maxRetryDuration: "4s",
maxBackoff: "3s",
minBackoff: "2s",
maxDoublings: 1,
},
stackdriverLoggingConfig: {
samplingRatio: 0.9,
},
});
import pulumi
import pulumi_gcp as gcp
advanced_configuration = gcp.cloudtasks.Queue("advanced_configuration",
name="instance-name",
location="us-central1",
app_engine_routing_override={
"service": "worker",
"version": "1.0",
"instance": "test",
},
rate_limits={
"max_concurrent_dispatches": 3,
"max_dispatches_per_second": 2,
},
retry_config={
"max_attempts": 5,
"max_retry_duration": "4s",
"max_backoff": "3s",
"min_backoff": "2s",
"max_doublings": 1,
},
stackdriver_logging_config={
"sampling_ratio": 0.9,
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudtasks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudtasks.NewQueue(ctx, "advanced_configuration", &cloudtasks.QueueArgs{
Name: pulumi.String("instance-name"),
Location: pulumi.String("us-central1"),
AppEngineRoutingOverride: &cloudtasks.QueueAppEngineRoutingOverrideArgs{
Service: pulumi.String("worker"),
Version: pulumi.String("1.0"),
Instance: pulumi.String("test"),
},
RateLimits: &cloudtasks.QueueRateLimitsArgs{
MaxConcurrentDispatches: pulumi.Int(3),
MaxDispatchesPerSecond: pulumi.Float64(2),
},
RetryConfig: &cloudtasks.QueueRetryConfigArgs{
MaxAttempts: pulumi.Int(5),
MaxRetryDuration: pulumi.String("4s"),
MaxBackoff: pulumi.String("3s"),
MinBackoff: pulumi.String("2s"),
MaxDoublings: pulumi.Int(1),
},
StackdriverLoggingConfig: &cloudtasks.QueueStackdriverLoggingConfigArgs{
SamplingRatio: pulumi.Float64(0.9),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var advancedConfiguration = new Gcp.CloudTasks.Queue("advanced_configuration", new()
{
Name = "instance-name",
Location = "us-central1",
AppEngineRoutingOverride = new Gcp.CloudTasks.Inputs.QueueAppEngineRoutingOverrideArgs
{
Service = "worker",
Version = "1.0",
Instance = "test",
},
RateLimits = new Gcp.CloudTasks.Inputs.QueueRateLimitsArgs
{
MaxConcurrentDispatches = 3,
MaxDispatchesPerSecond = 2,
},
RetryConfig = new Gcp.CloudTasks.Inputs.QueueRetryConfigArgs
{
MaxAttempts = 5,
MaxRetryDuration = "4s",
MaxBackoff = "3s",
MinBackoff = "2s",
MaxDoublings = 1,
},
StackdriverLoggingConfig = new Gcp.CloudTasks.Inputs.QueueStackdriverLoggingConfigArgs
{
SamplingRatio = 0.9,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudtasks.Queue;
import com.pulumi.gcp.cloudtasks.QueueArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueAppEngineRoutingOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueRateLimitsArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueRetryConfigArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueStackdriverLoggingConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var advancedConfiguration = new Queue("advancedConfiguration", QueueArgs.builder()
.name("instance-name")
.location("us-central1")
.appEngineRoutingOverride(QueueAppEngineRoutingOverrideArgs.builder()
.service("worker")
.version("1.0")
.instance("test")
.build())
.rateLimits(QueueRateLimitsArgs.builder()
.maxConcurrentDispatches(3)
.maxDispatchesPerSecond(2)
.build())
.retryConfig(QueueRetryConfigArgs.builder()
.maxAttempts(5)
.maxRetryDuration("4s")
.maxBackoff("3s")
.minBackoff("2s")
.maxDoublings(1)
.build())
.stackdriverLoggingConfig(QueueStackdriverLoggingConfigArgs.builder()
.samplingRatio(0.9)
.build())
.build());
}
}
resources:
advancedConfiguration:
type: gcp:cloudtasks:Queue
name: advanced_configuration
properties:
name: instance-name
location: us-central1
appEngineRoutingOverride:
service: worker
version: '1.0'
instance: test
rateLimits:
maxConcurrentDispatches: 3
maxDispatchesPerSecond: 2
retryConfig:
maxAttempts: 5
maxRetryDuration: 4s
maxBackoff: 3s
minBackoff: 2s
maxDoublings: 1
stackdriverLoggingConfig:
samplingRatio: 0.9
Cloud Tasks Queue Http Target Oidc
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const oidcServiceAccount = new gcp.serviceaccount.Account("oidc_service_account", {
accountId: "example-oidc",
displayName: "Tasks Queue OIDC Service Account",
});
const httpTargetOidc = new gcp.cloudtasks.Queue("http_target_oidc", {
name: "cloud-tasks-queue-http-target-oidc",
location: "us-central1",
httpTarget: {
httpMethod: "POST",
uriOverride: {
scheme: "HTTPS",
host: "oidc.example.com",
port: "8443",
pathOverride: {
path: "/users/1234",
},
queryOverride: {
queryParams: "qparam1=123&qparam2=456",
},
uriOverrideEnforceMode: "IF_NOT_EXISTS",
},
headerOverrides: [
{
header: {
key: "AddSomethingElse",
value: "MyOtherValue",
},
},
{
header: {
key: "AddMe",
value: "MyValue",
},
},
],
oidcToken: {
serviceAccountEmail: oidcServiceAccount.email,
audience: "https://oidc.example.com",
},
},
});
import pulumi
import pulumi_gcp as gcp
oidc_service_account = gcp.serviceaccount.Account("oidc_service_account",
account_id="example-oidc",
display_name="Tasks Queue OIDC Service Account")
http_target_oidc = gcp.cloudtasks.Queue("http_target_oidc",
name="cloud-tasks-queue-http-target-oidc",
location="us-central1",
http_target={
"http_method": "POST",
"uri_override": {
"scheme": "HTTPS",
"host": "oidc.example.com",
"port": "8443",
"path_override": {
"path": "/users/1234",
},
"query_override": {
"query_params": "qparam1=123&qparam2=456",
},
"uri_override_enforce_mode": "IF_NOT_EXISTS",
},
"header_overrides": [
{
"header": {
"key": "AddSomethingElse",
"value": "MyOtherValue",
},
},
{
"header": {
"key": "AddMe",
"value": "MyValue",
},
},
],
"oidc_token": {
"service_account_email": oidc_service_account.email,
"audience": "https://oidc.example.com",
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudtasks"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/serviceaccount"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
oidcServiceAccount, err := serviceaccount.NewAccount(ctx, "oidc_service_account", &serviceaccount.AccountArgs{
AccountId: pulumi.String("example-oidc"),
DisplayName: pulumi.String("Tasks Queue OIDC Service Account"),
})
if err != nil {
return err
}
_, err = cloudtasks.NewQueue(ctx, "http_target_oidc", &cloudtasks.QueueArgs{
Name: pulumi.String("cloud-tasks-queue-http-target-oidc"),
Location: pulumi.String("us-central1"),
HttpTarget: &cloudtasks.QueueHttpTargetArgs{
HttpMethod: pulumi.String("POST"),
UriOverride: &cloudtasks.QueueHttpTargetUriOverrideArgs{
Scheme: pulumi.String("HTTPS"),
Host: pulumi.String("oidc.example.com"),
Port: pulumi.String("8443"),
PathOverride: &cloudtasks.QueueHttpTargetUriOverridePathOverrideArgs{
Path: pulumi.String("/users/1234"),
},
QueryOverride: &cloudtasks.QueueHttpTargetUriOverrideQueryOverrideArgs{
QueryParams: pulumi.String("qparam1=123&qparam2=456"),
},
UriOverrideEnforceMode: pulumi.String("IF_NOT_EXISTS"),
},
HeaderOverrides: cloudtasks.QueueHttpTargetHeaderOverrideArray{
&cloudtasks.QueueHttpTargetHeaderOverrideArgs{
Header: &cloudtasks.QueueHttpTargetHeaderOverrideHeaderArgs{
Key: pulumi.String("AddSomethingElse"),
Value: pulumi.String("MyOtherValue"),
},
},
&cloudtasks.QueueHttpTargetHeaderOverrideArgs{
Header: &cloudtasks.QueueHttpTargetHeaderOverrideHeaderArgs{
Key: pulumi.String("AddMe"),
Value: pulumi.String("MyValue"),
},
},
},
OidcToken: &cloudtasks.QueueHttpTargetOidcTokenArgs{
ServiceAccountEmail: oidcServiceAccount.Email,
Audience: pulumi.String("https://oidc.example.com"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var oidcServiceAccount = new Gcp.ServiceAccount.Account("oidc_service_account", new()
{
AccountId = "example-oidc",
DisplayName = "Tasks Queue OIDC Service Account",
});
var httpTargetOidc = new Gcp.CloudTasks.Queue("http_target_oidc", new()
{
Name = "cloud-tasks-queue-http-target-oidc",
Location = "us-central1",
HttpTarget = new Gcp.CloudTasks.Inputs.QueueHttpTargetArgs
{
HttpMethod = "POST",
UriOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideArgs
{
Scheme = "HTTPS",
Host = "oidc.example.com",
Port = "8443",
PathOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverridePathOverrideArgs
{
Path = "/users/1234",
},
QueryOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideQueryOverrideArgs
{
QueryParams = "qparam1=123&qparam2=456",
},
UriOverrideEnforceMode = "IF_NOT_EXISTS",
},
HeaderOverrides = new[]
{
new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideArgs
{
Header = new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideHeaderArgs
{
Key = "AddSomethingElse",
Value = "MyOtherValue",
},
},
new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideArgs
{
Header = new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideHeaderArgs
{
Key = "AddMe",
Value = "MyValue",
},
},
},
OidcToken = new Gcp.CloudTasks.Inputs.QueueHttpTargetOidcTokenArgs
{
ServiceAccountEmail = oidcServiceAccount.Email,
Audience = "https://oidc.example.com",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.cloudtasks.Queue;
import com.pulumi.gcp.cloudtasks.QueueArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverridePathOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverrideQueryOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetOidcTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var oidcServiceAccount = new Account("oidcServiceAccount", AccountArgs.builder()
.accountId("example-oidc")
.displayName("Tasks Queue OIDC Service Account")
.build());
var httpTargetOidc = new Queue("httpTargetOidc", QueueArgs.builder()
.name("cloud-tasks-queue-http-target-oidc")
.location("us-central1")
.httpTarget(QueueHttpTargetArgs.builder()
.httpMethod("POST")
.uriOverride(QueueHttpTargetUriOverrideArgs.builder()
.scheme("HTTPS")
.host("oidc.example.com")
.port(8443)
.pathOverride(QueueHttpTargetUriOverridePathOverrideArgs.builder()
.path("/users/1234")
.build())
.queryOverride(QueueHttpTargetUriOverrideQueryOverrideArgs.builder()
.queryParams("qparam1=123&qparam2=456")
.build())
.uriOverrideEnforceMode("IF_NOT_EXISTS")
.build())
.headerOverrides(
QueueHttpTargetHeaderOverrideArgs.builder()
.header(QueueHttpTargetHeaderOverrideHeaderArgs.builder()
.key("AddSomethingElse")
.value("MyOtherValue")
.build())
.build(),
QueueHttpTargetHeaderOverrideArgs.builder()
.header(QueueHttpTargetHeaderOverrideHeaderArgs.builder()
.key("AddMe")
.value("MyValue")
.build())
.build())
.oidcToken(QueueHttpTargetOidcTokenArgs.builder()
.serviceAccountEmail(oidcServiceAccount.email())
.audience("https://oidc.example.com")
.build())
.build())
.build());
}
}
resources:
httpTargetOidc:
type: gcp:cloudtasks:Queue
name: http_target_oidc
properties:
name: cloud-tasks-queue-http-target-oidc
location: us-central1
httpTarget:
httpMethod: POST
uriOverride:
scheme: HTTPS
host: oidc.example.com
port: 8443
pathOverride:
path: /users/1234
queryOverride:
queryParams: qparam1=123&qparam2=456
uriOverrideEnforceMode: IF_NOT_EXISTS
headerOverrides:
- header:
key: AddSomethingElse
value: MyOtherValue
- header:
key: AddMe
value: MyValue
oidcToken:
serviceAccountEmail: ${oidcServiceAccount.email}
audience: https://oidc.example.com
oidcServiceAccount:
type: gcp:serviceaccount:Account
name: oidc_service_account
properties:
accountId: example-oidc
displayName: Tasks Queue OIDC Service Account
Cloud Tasks Queue Http Target Oauth
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const oauthServiceAccount = new gcp.serviceaccount.Account("oauth_service_account", {
accountId: "example-oauth",
displayName: "Tasks Queue OAuth Service Account",
});
const httpTargetOauth = new gcp.cloudtasks.Queue("http_target_oauth", {
name: "cloud-tasks-queue-http-target-oauth",
location: "us-central1",
httpTarget: {
httpMethod: "POST",
uriOverride: {
scheme: "HTTPS",
host: "oauth.example.com",
port: "8443",
pathOverride: {
path: "/users/1234",
},
queryOverride: {
queryParams: "qparam1=123&qparam2=456",
},
uriOverrideEnforceMode: "IF_NOT_EXISTS",
},
headerOverrides: [
{
header: {
key: "AddSomethingElse",
value: "MyOtherValue",
},
},
{
header: {
key: "AddMe",
value: "MyValue",
},
},
],
oauthToken: {
serviceAccountEmail: oauthServiceAccount.email,
scope: "openid https://www.googleapis.com/auth/userinfo.email",
},
},
});
import pulumi
import pulumi_gcp as gcp
oauth_service_account = gcp.serviceaccount.Account("oauth_service_account",
account_id="example-oauth",
display_name="Tasks Queue OAuth Service Account")
http_target_oauth = gcp.cloudtasks.Queue("http_target_oauth",
name="cloud-tasks-queue-http-target-oauth",
location="us-central1",
http_target={
"http_method": "POST",
"uri_override": {
"scheme": "HTTPS",
"host": "oauth.example.com",
"port": "8443",
"path_override": {
"path": "/users/1234",
},
"query_override": {
"query_params": "qparam1=123&qparam2=456",
},
"uri_override_enforce_mode": "IF_NOT_EXISTS",
},
"header_overrides": [
{
"header": {
"key": "AddSomethingElse",
"value": "MyOtherValue",
},
},
{
"header": {
"key": "AddMe",
"value": "MyValue",
},
},
],
"oauth_token": {
"service_account_email": oauth_service_account.email,
"scope": "openid https://www.googleapis.com/auth/userinfo.email",
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudtasks"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/serviceaccount"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
oauthServiceAccount, err := serviceaccount.NewAccount(ctx, "oauth_service_account", &serviceaccount.AccountArgs{
AccountId: pulumi.String("example-oauth"),
DisplayName: pulumi.String("Tasks Queue OAuth Service Account"),
})
if err != nil {
return err
}
_, err = cloudtasks.NewQueue(ctx, "http_target_oauth", &cloudtasks.QueueArgs{
Name: pulumi.String("cloud-tasks-queue-http-target-oauth"),
Location: pulumi.String("us-central1"),
HttpTarget: &cloudtasks.QueueHttpTargetArgs{
HttpMethod: pulumi.String("POST"),
UriOverride: &cloudtasks.QueueHttpTargetUriOverrideArgs{
Scheme: pulumi.String("HTTPS"),
Host: pulumi.String("oauth.example.com"),
Port: pulumi.String("8443"),
PathOverride: &cloudtasks.QueueHttpTargetUriOverridePathOverrideArgs{
Path: pulumi.String("/users/1234"),
},
QueryOverride: &cloudtasks.QueueHttpTargetUriOverrideQueryOverrideArgs{
QueryParams: pulumi.String("qparam1=123&qparam2=456"),
},
UriOverrideEnforceMode: pulumi.String("IF_NOT_EXISTS"),
},
HeaderOverrides: cloudtasks.QueueHttpTargetHeaderOverrideArray{
&cloudtasks.QueueHttpTargetHeaderOverrideArgs{
Header: &cloudtasks.QueueHttpTargetHeaderOverrideHeaderArgs{
Key: pulumi.String("AddSomethingElse"),
Value: pulumi.String("MyOtherValue"),
},
},
&cloudtasks.QueueHttpTargetHeaderOverrideArgs{
Header: &cloudtasks.QueueHttpTargetHeaderOverrideHeaderArgs{
Key: pulumi.String("AddMe"),
Value: pulumi.String("MyValue"),
},
},
},
OauthToken: &cloudtasks.QueueHttpTargetOauthTokenArgs{
ServiceAccountEmail: oauthServiceAccount.Email,
Scope: pulumi.String("openid https://www.googleapis.com/auth/userinfo.email"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var oauthServiceAccount = new Gcp.ServiceAccount.Account("oauth_service_account", new()
{
AccountId = "example-oauth",
DisplayName = "Tasks Queue OAuth Service Account",
});
var httpTargetOauth = new Gcp.CloudTasks.Queue("http_target_oauth", new()
{
Name = "cloud-tasks-queue-http-target-oauth",
Location = "us-central1",
HttpTarget = new Gcp.CloudTasks.Inputs.QueueHttpTargetArgs
{
HttpMethod = "POST",
UriOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideArgs
{
Scheme = "HTTPS",
Host = "oauth.example.com",
Port = "8443",
PathOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverridePathOverrideArgs
{
Path = "/users/1234",
},
QueryOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideQueryOverrideArgs
{
QueryParams = "qparam1=123&qparam2=456",
},
UriOverrideEnforceMode = "IF_NOT_EXISTS",
},
HeaderOverrides = new[]
{
new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideArgs
{
Header = new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideHeaderArgs
{
Key = "AddSomethingElse",
Value = "MyOtherValue",
},
},
new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideArgs
{
Header = new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideHeaderArgs
{
Key = "AddMe",
Value = "MyValue",
},
},
},
OauthToken = new Gcp.CloudTasks.Inputs.QueueHttpTargetOauthTokenArgs
{
ServiceAccountEmail = oauthServiceAccount.Email,
Scope = "openid https://www.googleapis.com/auth/userinfo.email",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.cloudtasks.Queue;
import com.pulumi.gcp.cloudtasks.QueueArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverridePathOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetUriOverrideQueryOverrideArgs;
import com.pulumi.gcp.cloudtasks.inputs.QueueHttpTargetOauthTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var oauthServiceAccount = new Account("oauthServiceAccount", AccountArgs.builder()
.accountId("example-oauth")
.displayName("Tasks Queue OAuth Service Account")
.build());
var httpTargetOauth = new Queue("httpTargetOauth", QueueArgs.builder()
.name("cloud-tasks-queue-http-target-oauth")
.location("us-central1")
.httpTarget(QueueHttpTargetArgs.builder()
.httpMethod("POST")
.uriOverride(QueueHttpTargetUriOverrideArgs.builder()
.scheme("HTTPS")
.host("oauth.example.com")
.port(8443)
.pathOverride(QueueHttpTargetUriOverridePathOverrideArgs.builder()
.path("/users/1234")
.build())
.queryOverride(QueueHttpTargetUriOverrideQueryOverrideArgs.builder()
.queryParams("qparam1=123&qparam2=456")
.build())
.uriOverrideEnforceMode("IF_NOT_EXISTS")
.build())
.headerOverrides(
QueueHttpTargetHeaderOverrideArgs.builder()
.header(QueueHttpTargetHeaderOverrideHeaderArgs.builder()
.key("AddSomethingElse")
.value("MyOtherValue")
.build())
.build(),
QueueHttpTargetHeaderOverrideArgs.builder()
.header(QueueHttpTargetHeaderOverrideHeaderArgs.builder()
.key("AddMe")
.value("MyValue")
.build())
.build())
.oauthToken(QueueHttpTargetOauthTokenArgs.builder()
.serviceAccountEmail(oauthServiceAccount.email())
.scope("openid https://www.googleapis.com/auth/userinfo.email")
.build())
.build())
.build());
}
}
resources:
httpTargetOauth:
type: gcp:cloudtasks:Queue
name: http_target_oauth
properties:
name: cloud-tasks-queue-http-target-oauth
location: us-central1
httpTarget:
httpMethod: POST
uriOverride:
scheme: HTTPS
host: oauth.example.com
port: 8443
pathOverride:
path: /users/1234
queryOverride:
queryParams: qparam1=123&qparam2=456
uriOverrideEnforceMode: IF_NOT_EXISTS
headerOverrides:
- header:
key: AddSomethingElse
value: MyOtherValue
- header:
key: AddMe
value: MyValue
oauthToken:
serviceAccountEmail: ${oauthServiceAccount.email}
scope: openid https://www.googleapis.com/auth/userinfo.email
oauthServiceAccount:
type: gcp:serviceaccount:Account
name: oauth_service_account
properties:
accountId: example-oauth
displayName: Tasks Queue OAuth Service Account
Create Queue Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
@overload
def Queue(resource_name: str,
args: QueueArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Queue(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
app_engine_routing_override: Optional[QueueAppEngineRoutingOverrideArgs] = None,
http_target: Optional[QueueHttpTargetArgs] = None,
name: Optional[str] = None,
project: Optional[str] = None,
rate_limits: Optional[QueueRateLimitsArgs] = None,
retry_config: Optional[QueueRetryConfigArgs] = None,
stackdriver_logging_config: Optional[QueueStackdriverLoggingConfigArgs] = None)
func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
type: gcp:cloudtasks:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QueueArgs
- 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 queueResource = new Gcp.CloudTasks.Queue("queueResource", new()
{
Location = "string",
AppEngineRoutingOverride = new Gcp.CloudTasks.Inputs.QueueAppEngineRoutingOverrideArgs
{
Host = "string",
Instance = "string",
Service = "string",
Version = "string",
},
HttpTarget = new Gcp.CloudTasks.Inputs.QueueHttpTargetArgs
{
HeaderOverrides = new[]
{
new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideArgs
{
Header = new Gcp.CloudTasks.Inputs.QueueHttpTargetHeaderOverrideHeaderArgs
{
Key = "string",
Value = "string",
},
},
},
HttpMethod = "string",
OauthToken = new Gcp.CloudTasks.Inputs.QueueHttpTargetOauthTokenArgs
{
ServiceAccountEmail = "string",
Scope = "string",
},
OidcToken = new Gcp.CloudTasks.Inputs.QueueHttpTargetOidcTokenArgs
{
ServiceAccountEmail = "string",
Audience = "string",
},
UriOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideArgs
{
Host = "string",
PathOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverridePathOverrideArgs
{
Path = "string",
},
Port = "string",
QueryOverride = new Gcp.CloudTasks.Inputs.QueueHttpTargetUriOverrideQueryOverrideArgs
{
QueryParams = "string",
},
Scheme = "string",
UriOverrideEnforceMode = "string",
},
},
Name = "string",
Project = "string",
RateLimits = new Gcp.CloudTasks.Inputs.QueueRateLimitsArgs
{
MaxBurstSize = 0,
MaxConcurrentDispatches = 0,
MaxDispatchesPerSecond = 0,
},
RetryConfig = new Gcp.CloudTasks.Inputs.QueueRetryConfigArgs
{
MaxAttempts = 0,
MaxBackoff = "string",
MaxDoublings = 0,
MaxRetryDuration = "string",
MinBackoff = "string",
},
StackdriverLoggingConfig = new Gcp.CloudTasks.Inputs.QueueStackdriverLoggingConfigArgs
{
SamplingRatio = 0,
},
});
example, err := cloudtasks.NewQueue(ctx, "queueResource", &cloudtasks.QueueArgs{
Location: pulumi.String("string"),
AppEngineRoutingOverride: &cloudtasks.QueueAppEngineRoutingOverrideArgs{
Host: pulumi.String("string"),
Instance: pulumi.String("string"),
Service: pulumi.String("string"),
Version: pulumi.String("string"),
},
HttpTarget: &cloudtasks.QueueHttpTargetArgs{
HeaderOverrides: cloudtasks.QueueHttpTargetHeaderOverrideArray{
&cloudtasks.QueueHttpTargetHeaderOverrideArgs{
Header: &cloudtasks.QueueHttpTargetHeaderOverrideHeaderArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
HttpMethod: pulumi.String("string"),
OauthToken: &cloudtasks.QueueHttpTargetOauthTokenArgs{
ServiceAccountEmail: pulumi.String("string"),
Scope: pulumi.String("string"),
},
OidcToken: &cloudtasks.QueueHttpTargetOidcTokenArgs{
ServiceAccountEmail: pulumi.String("string"),
Audience: pulumi.String("string"),
},
UriOverride: &cloudtasks.QueueHttpTargetUriOverrideArgs{
Host: pulumi.String("string"),
PathOverride: &cloudtasks.QueueHttpTargetUriOverridePathOverrideArgs{
Path: pulumi.String("string"),
},
Port: pulumi.String("string"),
QueryOverride: &cloudtasks.QueueHttpTargetUriOverrideQueryOverrideArgs{
QueryParams: pulumi.String("string"),
},
Scheme: pulumi.String("string"),
UriOverrideEnforceMode: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
RateLimits: &cloudtasks.QueueRateLimitsArgs{
MaxBurstSize: pulumi.Int(0),
MaxConcurrentDispatches: pulumi.Int(0),
MaxDispatchesPerSecond: pulumi.Float64(0),
},
RetryConfig: &cloudtasks.QueueRetryConfigArgs{
MaxAttempts: pulumi.Int(0),
MaxBackoff: pulumi.String("string"),
MaxDoublings: pulumi.Int(0),
MaxRetryDuration: pulumi.String("string"),
MinBackoff: pulumi.String("string"),
},
StackdriverLoggingConfig: &cloudtasks.QueueStackdriverLoggingConfigArgs{
SamplingRatio: pulumi.Float64(0),
},
})
var queueResource = new Queue("queueResource", QueueArgs.builder()
.location("string")
.appEngineRoutingOverride(QueueAppEngineRoutingOverrideArgs.builder()
.host("string")
.instance("string")
.service("string")
.version("string")
.build())
.httpTarget(QueueHttpTargetArgs.builder()
.headerOverrides(QueueHttpTargetHeaderOverrideArgs.builder()
.header(QueueHttpTargetHeaderOverrideHeaderArgs.builder()
.key("string")
.value("string")
.build())
.build())
.httpMethod("string")
.oauthToken(QueueHttpTargetOauthTokenArgs.builder()
.serviceAccountEmail("string")
.scope("string")
.build())
.oidcToken(QueueHttpTargetOidcTokenArgs.builder()
.serviceAccountEmail("string")
.audience("string")
.build())
.uriOverride(QueueHttpTargetUriOverrideArgs.builder()
.host("string")
.pathOverride(QueueHttpTargetUriOverridePathOverrideArgs.builder()
.path("string")
.build())
.port("string")
.queryOverride(QueueHttpTargetUriOverrideQueryOverrideArgs.builder()
.queryParams("string")
.build())
.scheme("string")
.uriOverrideEnforceMode("string")
.build())
.build())
.name("string")
.project("string")
.rateLimits(QueueRateLimitsArgs.builder()
.maxBurstSize(0)
.maxConcurrentDispatches(0)
.maxDispatchesPerSecond(0)
.build())
.retryConfig(QueueRetryConfigArgs.builder()
.maxAttempts(0)
.maxBackoff("string")
.maxDoublings(0)
.maxRetryDuration("string")
.minBackoff("string")
.build())
.stackdriverLoggingConfig(QueueStackdriverLoggingConfigArgs.builder()
.samplingRatio(0)
.build())
.build());
queue_resource = gcp.cloudtasks.Queue("queueResource",
location="string",
app_engine_routing_override={
"host": "string",
"instance": "string",
"service": "string",
"version": "string",
},
http_target={
"header_overrides": [{
"header": {
"key": "string",
"value": "string",
},
}],
"http_method": "string",
"oauth_token": {
"service_account_email": "string",
"scope": "string",
},
"oidc_token": {
"service_account_email": "string",
"audience": "string",
},
"uri_override": {
"host": "string",
"path_override": {
"path": "string",
},
"port": "string",
"query_override": {
"query_params": "string",
},
"scheme": "string",
"uri_override_enforce_mode": "string",
},
},
name="string",
project="string",
rate_limits={
"max_burst_size": 0,
"max_concurrent_dispatches": 0,
"max_dispatches_per_second": 0,
},
retry_config={
"max_attempts": 0,
"max_backoff": "string",
"max_doublings": 0,
"max_retry_duration": "string",
"min_backoff": "string",
},
stackdriver_logging_config={
"sampling_ratio": 0,
})
const queueResource = new gcp.cloudtasks.Queue("queueResource", {
location: "string",
appEngineRoutingOverride: {
host: "string",
instance: "string",
service: "string",
version: "string",
},
httpTarget: {
headerOverrides: [{
header: {
key: "string",
value: "string",
},
}],
httpMethod: "string",
oauthToken: {
serviceAccountEmail: "string",
scope: "string",
},
oidcToken: {
serviceAccountEmail: "string",
audience: "string",
},
uriOverride: {
host: "string",
pathOverride: {
path: "string",
},
port: "string",
queryOverride: {
queryParams: "string",
},
scheme: "string",
uriOverrideEnforceMode: "string",
},
},
name: "string",
project: "string",
rateLimits: {
maxBurstSize: 0,
maxConcurrentDispatches: 0,
maxDispatchesPerSecond: 0,
},
retryConfig: {
maxAttempts: 0,
maxBackoff: "string",
maxDoublings: 0,
maxRetryDuration: "string",
minBackoff: "string",
},
stackdriverLoggingConfig: {
samplingRatio: 0,
},
});
type: gcp:cloudtasks:Queue
properties:
appEngineRoutingOverride:
host: string
instance: string
service: string
version: string
httpTarget:
headerOverrides:
- header:
key: string
value: string
httpMethod: string
oauthToken:
scope: string
serviceAccountEmail: string
oidcToken:
audience: string
serviceAccountEmail: string
uriOverride:
host: string
pathOverride:
path: string
port: string
queryOverride:
queryParams: string
scheme: string
uriOverrideEnforceMode: string
location: string
name: string
project: string
rateLimits:
maxBurstSize: 0
maxConcurrentDispatches: 0
maxDispatchesPerSecond: 0
retryConfig:
maxAttempts: 0
maxBackoff: string
maxDoublings: 0
maxRetryDuration: string
minBackoff: string
stackdriverLoggingConfig:
samplingRatio: 0
Queue 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 Queue resource accepts the following input properties:
- Location string
- The location of the queue
- App
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- Http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- Name string
- The queue name.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- Retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- Stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- Location string
- The location of the queue
- App
Engine QueueRouting Override App Engine Routing Override Args - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- Http
Target QueueHttp Target Args - Modifies HTTP target for HTTP tasks. Structure is documented below.
- Name string
- The queue name.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rate
Limits QueueRate Limits Args - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- Retry
Config QueueRetry Config Args - Settings that determine the retry behavior. Structure is documented below.
- Stackdriver
Logging QueueConfig Stackdriver Logging Config Args - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- location String
- The location of the queue
- app
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- name String
- The queue name.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- location string
- The location of the queue
- app
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- name string
- The queue name.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- location str
- The location of the queue
- app_
engine_ Queuerouting_ override App Engine Routing Override Args - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http_
target QueueHttp Target Args - Modifies HTTP target for HTTP tasks. Structure is documented below.
- name str
- The queue name.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate_
limits QueueRate Limits Args - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry_
config QueueRetry Config Args - Settings that determine the retry behavior. Structure is documented below.
- stackdriver_
logging_ Queueconfig Stackdriver Logging Config Args - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- location String
- The location of the queue
- app
Engine Property MapRouting Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target Property Map - Modifies HTTP target for HTTP tasks. Structure is documented below.
- name String
- The queue name.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits Property Map - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config Property Map - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging Property MapConfig - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Queue Resource
Get an existing Queue 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?: QueueState, opts?: CustomResourceOptions): Queue
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_engine_routing_override: Optional[QueueAppEngineRoutingOverrideArgs] = None,
http_target: Optional[QueueHttpTargetArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
rate_limits: Optional[QueueRateLimitsArgs] = None,
retry_config: Optional[QueueRetryConfigArgs] = None,
stackdriver_logging_config: Optional[QueueStackdriverLoggingConfigArgs] = None) -> Queue
func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)
public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)
public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- App
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- Http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- Location string
- The location of the queue
- Name string
- The queue name.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- Retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- Stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- App
Engine QueueRouting Override App Engine Routing Override Args - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- Http
Target QueueHttp Target Args - Modifies HTTP target for HTTP tasks. Structure is documented below.
- Location string
- The location of the queue
- Name string
- The queue name.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rate
Limits QueueRate Limits Args - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- Retry
Config QueueRetry Config Args - Settings that determine the retry behavior. Structure is documented below.
- Stackdriver
Logging QueueConfig Stackdriver Logging Config Args - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- app
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- location String
- The location of the queue
- name String
- The queue name.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- app
Engine QueueRouting Override App Engine Routing Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target QueueHttp Target - Modifies HTTP target for HTTP tasks. Structure is documented below.
- location string
- The location of the queue
- name string
- The queue name.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits QueueRate Limits - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config QueueRetry Config - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging QueueConfig Stackdriver Logging Config - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- app_
engine_ Queuerouting_ override App Engine Routing Override Args - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http_
target QueueHttp Target Args - Modifies HTTP target for HTTP tasks. Structure is documented below.
- location str
- The location of the queue
- name str
- The queue name.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate_
limits QueueRate Limits Args - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry_
config QueueRetry Config Args - Settings that determine the retry behavior. Structure is documented below.
- stackdriver_
logging_ Queueconfig Stackdriver Logging Config Args - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
- app
Engine Property MapRouting Override - Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
- http
Target Property Map - Modifies HTTP target for HTTP tasks. Structure is documented below.
- location String
- The location of the queue
- name String
- The queue name.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rate
Limits Property Map - Rate limits for task dispatches.
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rateLimits, retryConfig, and the queue's state.
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
- retry
Config Property Map - Settings that determine the retry behavior. Structure is documented below.
- stackdriver
Logging Property MapConfig - Configuration options for writing logs to Stackdriver Logging. Structure is documented below.
Supporting Types
QueueAppEngineRoutingOverride, QueueAppEngineRoutingOverrideArgs
- Host string
- (Output) The host that the task is sent to.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
- Host string
- (Output) The host that the task is sent to.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
- host String
- (Output) The host that the task is sent to.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
- host string
- (Output) The host that the task is sent to.
- instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
- host str
- (Output) The host that the task is sent to.
- instance str
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- service str
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- version str
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
- host String
- (Output) The host that the task is sent to.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted.
QueueHttpTarget, QueueHttpTargetArgs
- Header
Overrides List<QueueHttp Target Header Override> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- Http
Method string - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - Oauth
Token QueueHttp Target Oauth Token - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- Oidc
Token QueueHttp Target Oidc Token - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- Uri
Override QueueHttp Target Uri Override - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
- Header
Overrides []QueueHttp Target Header Override - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- Http
Method string - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - Oauth
Token QueueHttp Target Oauth Token - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- Oidc
Token QueueHttp Target Oidc Token - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- Uri
Override QueueHttp Target Uri Override - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
- header
Overrides List<QueueHttp Target Header Override> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- http
Method String - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - oauth
Token QueueHttp Target Oauth Token - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- oidc
Token QueueHttp Target Oidc Token - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- uri
Override QueueHttp Target Uri Override - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
- header
Overrides QueueHttp Target Header Override[] - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- http
Method string - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - oauth
Token QueueHttp Target Oauth Token - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- oidc
Token QueueHttp Target Oidc Token - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- uri
Override QueueHttp Target Uri Override - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
- header_
overrides Sequence[QueueHttp Target Header Override] - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- http_
method str - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - oauth_
token QueueHttp Target Oauth Token - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- oidc_
token QueueHttp Target Oidc Token - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- uri_
override QueueHttp Target Uri Override - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
- header
Overrides List<Property Map> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Structure is documented below.
- http
Method String - The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task.
Note that if the value is set to GET the body of the task will be ignored at execution time.
Possible values are:
HTTP_METHOD_UNSPECIFIED
,POST
,GET
,HEAD
,PUT
,DELETE
,PATCH
,OPTIONS
. - oauth
Token Property Map - If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. Structure is documented below.
- oidc
Token Property Map - If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. Structure is documented below.
- uri
Override Property Map - URI override. When specified, overrides the execution URI for all the tasks in the queue. Structure is documented below.
QueueHttpTargetHeaderOverride, QueueHttpTargetHeaderOverrideArgs
- Header
Queue
Http Target Header Override Header - Header embodying a key and a value. Structure is documented below.
- Header
Queue
Http Target Header Override Header - Header embodying a key and a value. Structure is documented below.
- header
Queue
Http Target Header Override Header - Header embodying a key and a value. Structure is documented below.
- header
Queue
Http Target Header Override Header - Header embodying a key and a value. Structure is documented below.
- header
Queue
Http Target Header Override Header - Header embodying a key and a value. Structure is documented below.
- header Property Map
- Header embodying a key and a value. Structure is documented below.
QueueHttpTargetHeaderOverrideHeader, QueueHttpTargetHeaderOverrideHeaderArgs
QueueHttpTargetOauthToken, QueueHttpTargetOauthTokenArgs
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service_
account_ stremail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope str
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
QueueHttpTargetOidcToken, QueueHttpTargetOidcTokenArgs
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ stremail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience str
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
QueueHttpTargetUriOverride, QueueHttpTargetUriOverrideArgs
- Host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- Path
Override QueueHttp Target Uri Override Path Override - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- Port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- Query
Override QueueHttp Target Uri Override Query Override - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- Scheme string
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - Uri
Override stringEnforce Mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
- Host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- Path
Override QueueHttp Target Uri Override Path Override - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- Port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- Query
Override QueueHttp Target Uri Override Query Override - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- Scheme string
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - Uri
Override stringEnforce Mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
- host String
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override QueueHttp Target Uri Override Path Override - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- port String
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override QueueHttp Target Uri Override Query Override - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- scheme String
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - uri
Override StringEnforce Mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
- host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override QueueHttp Target Uri Override Path Override - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override QueueHttp Target Uri Override Query Override - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- scheme string
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - uri
Override stringEnforce Mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
- host str
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- path_
override QueueHttp Target Uri Override Path Override - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- port str
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query_
override QueueHttp Target Uri Override Query Override - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- scheme str
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - uri_
override_ strenforce_ mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
- host String
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com", and host value is set to "example.net", the overridden URI will be changed to "https://example.net". Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override Property Map - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. Structure is documented below.
- port String
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override Property Map - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. Structure is documented below.
- scheme String
- Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
Possible values are:
HTTP
,HTTPS
. - uri
Override StringEnforce Mode - URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Possible values are:
ALWAYS
,IF_NOT_EXISTS
.
QueueHttpTargetUriOverridePathOverride, QueueHttpTargetUriOverridePathOverrideArgs
- Path string
- The URI path (e.g., /users/1234). Default is an empty string.
- Path string
- The URI path (e.g., /users/1234). Default is an empty string.
- path String
- The URI path (e.g., /users/1234). Default is an empty string.
- path string
- The URI path (e.g., /users/1234). Default is an empty string.
- path str
- The URI path (e.g., /users/1234). Default is an empty string.
- path String
- The URI path (e.g., /users/1234). Default is an empty string.
QueueHttpTargetUriOverrideQueryOverride, QueueHttpTargetUriOverrideQueryOverrideArgs
- Query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- Query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params String - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query_
params str - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params String - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
QueueRateLimits, QueueRateLimitsArgs
- Max
Burst intSize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- Max
Concurrent intDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- Max
Dispatches doublePer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
- Max
Burst intSize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- Max
Concurrent intDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- Max
Dispatches float64Per Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
- max
Burst IntegerSize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- max
Concurrent IntegerDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- max
Dispatches DoublePer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
- max
Burst numberSize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- max
Concurrent numberDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- max
Dispatches numberPer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
- max_
burst_ intsize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- max_
concurrent_ intdispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- max_
dispatches_ floatper_ second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
- max
Burst NumberSize - (Output) The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
- max
Concurrent NumberDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- max
Dispatches NumberPer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.
QueueRetryConfig, QueueRetryConfigArgs
- Max
Attempts int - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- Max
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- Max
Doublings int - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- Max
Retry stringDuration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- Min
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- Max
Attempts int - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- Max
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- Max
Doublings int - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- Max
Retry stringDuration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- Min
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Attempts Integer - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- max
Backoff String - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Doublings Integer - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- max
Retry StringDuration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- min
Backoff String - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Attempts number - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- max
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Doublings number - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- max
Retry stringDuration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- min
Backoff string - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max_
attempts int - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- max_
backoff str - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max_
doublings int - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- max_
retry_ strduration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- min_
backoff str - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Attempts Number - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
- max
Backoff String - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
- max
Doublings Number - The time between retries will double maxDoublings times. A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
- max
Retry StringDuration - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
- min
Backoff String - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.
QueueStackdriverLoggingConfig, QueueStackdriverLoggingConfigArgs
- Sampling
Ratio double - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- Sampling
Ratio float64 - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio Double - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio number - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling_
ratio float - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio Number - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
Import
Queue can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/queues/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}
When using the pulumi import
command, Queue can be imported using one of the formats above. For example:
$ pulumi import gcp:cloudtasks/queue:Queue default projects/{{project}}/locations/{{location}}/queues/{{name}}
$ pulumi import gcp:cloudtasks/queue:Queue default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:cloudtasks/queue:Queue default {{location}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.