pubsub

class pulumi_gcp.pubsub.Subscription(resource_name, opts=None, ack_deadline_seconds=None, name=None, project=None, push_config=None, topic=None, __name__=None, __opts__=None)

Creates a subscription in Google’s pubsub queueing system. For more information see the official documentation and API.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • ack_deadline_seconds (pulumi.Input[int]) – The maximum number of seconds a subscriber has to acknowledge a received message, otherwise the message is redelivered. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – A unique name for the resource, required by pubsub. Changing this forces a new resource to be created.
  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
  • push_config (pulumi.Input[dict]) – Block configuration for push options. More configuration options are detailed below.
  • topic (pulumi.Input[str]) – The topic name or id to bind this subscription to, required by pubsub. Changing this forces a new resource to be created.
ack_deadline_seconds = None

The maximum number of seconds a subscriber has to acknowledge a received message, otherwise the message is redelivered. Changing this forces a new resource to be created.

name = None

A unique name for the resource, required by pubsub. Changing this forces a new resource to be created.

path = None

Path of the subscription in the format projects/{project}/subscriptions/{sub}

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

push_config = None

Block configuration for push options. More configuration options are detailed below.

topic = None

The topic name or id to bind this subscription to, required by pubsub. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.SubscriptionIAMBinding(resource_name, opts=None, members=None, project=None, role=None, subscription=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub subscription. Each of these resources serves a different use case:

  • google_pubsub_subscription_iam_policy: Authoritative. Sets the IAM policy for the subscription and replaces any existing policy already attached.
  • google_pubsub_subscription_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the subscription are preserved.
  • google_pubsub_subscription_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subscription are preserved.

Note: google_pubsub_subscription_iam_policy cannot be used in conjunction with google_pubsub_subscription_iam_binding and google_pubsub_subscription_iam_member or they will fight over what your policy should be.

Note: google_pubsub_subscription_iam_binding resources can be used in conjunction with google_pubsub_subscription_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.

:param pulumi.Input[list] members :param pulumi.Input[str] project: The project in which the resource belongs. If it

is not provided, the provider project is used.
Parameters:
  • role (pulumi.Input[str]) – The role that should be applied. Only one google_pubsub_subscription_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
  • subscription (pulumi.Input[str]) – The subscription name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the subscription’s IAM policy.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one google_pubsub_subscription_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

subscription = None

The subscription name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.SubscriptionIAMMember(resource_name, opts=None, member=None, project=None, role=None, subscription=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub subscription. Each of these resources serves a different use case:

  • google_pubsub_subscription_iam_policy: Authoritative. Sets the IAM policy for the subscription and replaces any existing policy already attached.
  • google_pubsub_subscription_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the subscription are preserved.
  • google_pubsub_subscription_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subscription are preserved.

Note: google_pubsub_subscription_iam_policy cannot be used in conjunction with google_pubsub_subscription_iam_binding and google_pubsub_subscription_iam_member or they will fight over what your policy should be.

Note: google_pubsub_subscription_iam_binding resources can be used in conjunction with google_pubsub_subscription_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.

:param pulumi.Input[str] member :param pulumi.Input[str] project: The project in which the resource belongs. If it

is not provided, the provider project is used.
Parameters:
  • role (pulumi.Input[str]) – The role that should be applied. Only one google_pubsub_subscription_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
  • subscription (pulumi.Input[str]) – The subscription name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the subscription’s IAM policy.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one google_pubsub_subscription_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

subscription = None

The subscription name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.SubscriptionIAMPolicy(resource_name, opts=None, policy_data=None, project=None, subscription=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub subscription. Each of these resources serves a different use case:

  • google_pubsub_subscription_iam_policy: Authoritative. Sets the IAM policy for the subscription and replaces any existing policy already attached.
  • google_pubsub_subscription_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the subscription are preserved.
  • google_pubsub_subscription_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subscription are preserved.

Note: google_pubsub_subscription_iam_policy cannot be used in conjunction with google_pubsub_subscription_iam_binding and google_pubsub_subscription_iam_member or they will fight over what your policy should be.

Note: google_pubsub_subscription_iam_binding resources can be used in conjunction with google_pubsub_subscription_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • policy_data (pulumi.Input[str]) – The policy data generated by a google_iam_policy data source.
  • project (pulumi.Input[str]) – The project in which the resource belongs. If it is not provided, the provider project is used.
  • subscription (pulumi.Input[str]) – The subscription name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the subscription’s IAM policy.

policy_data = None

The policy data generated by a google_iam_policy data source.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

subscription = None

The subscription name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.Topic(resource_name, opts=None, name=None, project=None, __name__=None, __opts__=None)

Creates a topic in Google’s pubsub queueing system. For more information see the official documentation and API.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – A unique name for the pubsub topic. Changing this forces a new resource to be created.
  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
name = None

A unique name for the pubsub topic. Changing this forces a new resource to be created.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.TopicIAMBinding(resource_name, opts=None, members=None, project=None, role=None, topic=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub topic. Each of these resources serves a different use case:

  • google_pubsub_topic_iam_policy: Authoritative. Sets the IAM policy for the topic and replaces any existing policy already attached.
  • google_pubsub_topic_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the topic are preserved.
  • google_pubsub_topic_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the topic are preserved.

Note: google_pubsub_topic_iam_policy cannot be used in conjunction with google_pubsub_topic_iam_binding and google_pubsub_topic_iam_member or they will fight over what your policy should be.

Note: google_pubsub_topic_iam_binding resources can be used in conjunction with google_pubsub_topic_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.

:param pulumi.Input[list] members :param pulumi.Input[str] project: The project in which the resource belongs. If it

is not provided, the provider project is used.
Parameters:
  • role (pulumi.Input[str]) – The role that should be applied. Only one google_pubsub_topic_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
  • topic (pulumi.Input[str]) – The topic name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the topic’s IAM policy.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one google_pubsub_topic_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

topic = None

The topic name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.TopicIAMMember(resource_name, opts=None, member=None, project=None, role=None, topic=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub topic. Each of these resources serves a different use case:

  • google_pubsub_topic_iam_policy: Authoritative. Sets the IAM policy for the topic and replaces any existing policy already attached.
  • google_pubsub_topic_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the topic are preserved.
  • google_pubsub_topic_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the topic are preserved.

Note: google_pubsub_topic_iam_policy cannot be used in conjunction with google_pubsub_topic_iam_binding and google_pubsub_topic_iam_member or they will fight over what your policy should be.

Note: google_pubsub_topic_iam_binding resources can be used in conjunction with google_pubsub_topic_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.

:param pulumi.Input[str] member :param pulumi.Input[str] project: The project in which the resource belongs. If it

is not provided, the provider project is used.
Parameters:
  • role (pulumi.Input[str]) – The role that should be applied. Only one google_pubsub_topic_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
  • topic (pulumi.Input[str]) – The topic name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the topic’s IAM policy.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one google_pubsub_topic_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

topic = None

The topic name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.pubsub.TopicIAMPolicy(resource_name, opts=None, policy_data=None, project=None, topic=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for pubsub topic. Each of these resources serves a different use case:

  • google_pubsub_topic_iam_policy: Authoritative. Sets the IAM policy for the topic and replaces any existing policy already attached.
  • google_pubsub_topic_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the topic are preserved.
  • google_pubsub_topic_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the topic are preserved.

Note: google_pubsub_topic_iam_policy cannot be used in conjunction with google_pubsub_topic_iam_binding and google_pubsub_topic_iam_member or they will fight over what your policy should be.

Note: google_pubsub_topic_iam_binding resources can be used in conjunction with google_pubsub_topic_iam_member resources only if they do not grant privilege to the same role.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • policy_data (pulumi.Input[str]) – The policy data generated by a google_iam_policy data source.
  • project (pulumi.Input[str]) – The project in which the resource belongs. If it is not provided, the provider project is used.
  • topic (pulumi.Input[str]) – The topic name or id to bind to attach IAM policy to.
etag = None

(Computed) The etag of the topic’s IAM policy.

policy_data = None

The policy data generated by a google_iam_policy data source.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

topic = None

The topic name or id to bind to attach IAM policy to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str