Google Native

Pulumi Official
Package maintained by Pulumi
v0.20.0 published on Monday, Jun 6, 2022 by Pulumi

Subscription

Creates a new subscription.

Create a Subscription Resource

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 delivery_config: Optional[DeliveryConfigArgs] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 skip_backlog: Optional[str] = None,
                 subscription_id: Optional[str] = None,
                 topic: Optional[str] = None)
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)
func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)
type: google-native:pubsublite/v1:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args SubscriptionArgs
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 SubscriptionArgs
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 SubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Subscription Resource Properties

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

Inputs

The Subscription resource accepts the following input properties:

SubscriptionId string

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

DeliveryConfig Pulumi.GoogleNative.Pubsublite.V1.Inputs.DeliveryConfigArgs

The settings for this subscription's message delivery.

Location string
Name string

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

Project string
SkipBacklog string

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

Topic string

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

SubscriptionId string

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

DeliveryConfig DeliveryConfigArgs

The settings for this subscription's message delivery.

Location string
Name string

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

Project string
SkipBacklog string

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

Topic string

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

subscriptionId String

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

deliveryConfig DeliveryConfigArgs

The settings for this subscription's message delivery.

location String
name String

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

project String
skipBacklog String

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

topic String

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

subscriptionId string

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

deliveryConfig DeliveryConfigArgs

The settings for this subscription's message delivery.

location string
name string

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

project string
skipBacklog string

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

topic string

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

subscription_id str

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

delivery_config DeliveryConfigArgs

The settings for this subscription's message delivery.

location str
name str

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

project str
skip_backlog str

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

topic str

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

subscriptionId String

Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.

deliveryConfig Property Map

The settings for this subscription's message delivery.

location String
name String

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

project String
skipBacklog String

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

topic String

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

Outputs

All input properties are implicitly available as output properties. Additionally, the Subscription 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.

Supporting Types

DeliveryConfig

DeliveryRequirement DeliveryConfigDeliveryRequirement

The DeliveryRequirement for this subscription.

deliveryRequirement DeliveryConfigDeliveryRequirement

The DeliveryRequirement for this subscription.

deliveryRequirement DeliveryConfigDeliveryRequirement

The DeliveryRequirement for this subscription.

delivery_requirement DeliveryConfigDeliveryRequirement

The DeliveryRequirement for this subscription.

DeliveryConfigDeliveryRequirement

DeliveryRequirementUnspecified
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

DeliverImmediately
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

DeliverAfterStored
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

DeliveryConfigDeliveryRequirementDeliveryRequirementUnspecified
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

DeliveryConfigDeliveryRequirementDeliverImmediately
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

DeliveryConfigDeliveryRequirementDeliverAfterStored
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

DeliveryRequirementUnspecified
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

DeliverImmediately
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

DeliverAfterStored
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

DeliveryRequirementUnspecified
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

DeliverImmediately
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

DeliverAfterStored
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

DELIVERY_REQUIREMENT_UNSPECIFIED
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

DELIVER_IMMEDIATELY
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

DELIVER_AFTER_STORED
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

"DELIVERY_REQUIREMENT_UNSPECIFIED"
DELIVERY_REQUIREMENT_UNSPECIFIED

Default value. This value is unused.

"DELIVER_IMMEDIATELY"
DELIVER_IMMEDIATELY

The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.

"DELIVER_AFTER_STORED"
DELIVER_AFTER_STORED

The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

DeliveryConfigResponse

DeliveryRequirement string

The DeliveryRequirement for this subscription.

DeliveryRequirement string

The DeliveryRequirement for this subscription.

deliveryRequirement String

The DeliveryRequirement for this subscription.

deliveryRequirement string

The DeliveryRequirement for this subscription.

delivery_requirement str

The DeliveryRequirement for this subscription.

deliveryRequirement String

The DeliveryRequirement for this subscription.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0