gcp.eventarc.GoogleApiSource
Explore with Pulumi AI
The Eventarc GoogleApiSource resource
To get more information about GoogleApiSource, see:
- API documentation
- How-to Guides
Example Usage
Eventarc Google Api Source With Cmek
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const testProject = gcp.organizations.getProject({
    projectId: "my-project-name",
});
const testKeyRing = gcp.kms.getKMSKeyRing({
    name: "keyring",
    location: "us-central1",
});
const key = testKeyRing.then(testKeyRing => gcp.kms.getKMSCryptoKey({
    name: "key",
    keyRing: testKeyRing.id,
}));
const keyMember = new gcp.kms.CryptoKeyIAMMember("key_member", {
    cryptoKeyId: key.then(key => key.id),
    role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member: testProject.then(testProject => `serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com`),
});
const messageBus = new gcp.eventarc.MessageBus("message_bus", {
    location: "us-central1",
    messageBusId: "some-message-bus",
});
const primary = new gcp.eventarc.GoogleApiSource("primary", {
    location: "us-central1",
    googleApiSourceId: "some-google-api-source",
    destination: messageBus.id,
    cryptoKeyName: key.then(key => key.id),
}, {
    dependsOn: [keyMember],
});
import pulumi
import pulumi_gcp as gcp
test_project = gcp.organizations.get_project(project_id="my-project-name")
test_key_ring = gcp.kms.get_kms_key_ring(name="keyring",
    location="us-central1")
key = gcp.kms.get_kms_crypto_key(name="key",
    key_ring=test_key_ring.id)
key_member = gcp.kms.CryptoKeyIAMMember("key_member",
    crypto_key_id=key.id,
    role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member=f"serviceAccount:service-{test_project.number}@gcp-sa-eventarc.iam.gserviceaccount.com")
message_bus = gcp.eventarc.MessageBus("message_bus",
    location="us-central1",
    message_bus_id="some-message-bus")
primary = gcp.eventarc.GoogleApiSource("primary",
    location="us-central1",
    google_api_source_id="some-google-api-source",
    destination=message_bus.id,
    crypto_key_name=key.id,
    opts = pulumi.ResourceOptions(depends_on=[key_member]))
package main
import (
	"fmt"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/eventarc"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testProject, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{
			ProjectId: pulumi.StringRef("my-project-name"),
		}, nil)
		if err != nil {
			return err
		}
		testKeyRing, err := kms.GetKMSKeyRing(ctx, &kms.GetKMSKeyRingArgs{
			Name:     "keyring",
			Location: "us-central1",
		}, nil)
		if err != nil {
			return err
		}
		key, err := kms.GetKMSCryptoKey(ctx, &kms.GetKMSCryptoKeyArgs{
			Name:    "key",
			KeyRing: testKeyRing.Id,
		}, nil)
		if err != nil {
			return err
		}
		keyMember, err := kms.NewCryptoKeyIAMMember(ctx, "key_member", &kms.CryptoKeyIAMMemberArgs{
			CryptoKeyId: pulumi.String(key.Id),
			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
			Member:      pulumi.Sprintf("serviceAccount:service-%v@gcp-sa-eventarc.iam.gserviceaccount.com", testProject.Number),
		})
		if err != nil {
			return err
		}
		messageBus, err := eventarc.NewMessageBus(ctx, "message_bus", &eventarc.MessageBusArgs{
			Location:     pulumi.String("us-central1"),
			MessageBusId: pulumi.String("some-message-bus"),
		})
		if err != nil {
			return err
		}
		_, err = eventarc.NewGoogleApiSource(ctx, "primary", &eventarc.GoogleApiSourceArgs{
			Location:          pulumi.String("us-central1"),
			GoogleApiSourceId: pulumi.String("some-google-api-source"),
			Destination:       messageBus.ID(),
			CryptoKeyName:     pulumi.String(key.Id),
		}, pulumi.DependsOn([]pulumi.Resource{
			keyMember,
		}))
		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 testProject = Gcp.Organizations.GetProject.Invoke(new()
    {
        ProjectId = "my-project-name",
    });
    var testKeyRing = Gcp.Kms.GetKMSKeyRing.Invoke(new()
    {
        Name = "keyring",
        Location = "us-central1",
    });
    var key = Gcp.Kms.GetKMSCryptoKey.Invoke(new()
    {
        Name = "key",
        KeyRing = testKeyRing.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
    });
    var keyMember = new Gcp.Kms.CryptoKeyIAMMember("key_member", new()
    {
        CryptoKeyId = key.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
        Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        Member = $"serviceAccount:service-{testProject.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-eventarc.iam.gserviceaccount.com",
    });
    var messageBus = new Gcp.Eventarc.MessageBus("message_bus", new()
    {
        Location = "us-central1",
        MessageBusId = "some-message-bus",
    });
    var primary = new Gcp.Eventarc.GoogleApiSource("primary", new()
    {
        Location = "us-central1",
        GoogleApiSourceId = "some-google-api-source",
        Destination = messageBus.Id,
        CryptoKeyName = key.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            keyMember,
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.kms.KmsFunctions;
import com.pulumi.gcp.kms.inputs.GetKMSKeyRingArgs;
import com.pulumi.gcp.kms.inputs.GetKMSCryptoKeyArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.eventarc.MessageBus;
import com.pulumi.gcp.eventarc.MessageBusArgs;
import com.pulumi.gcp.eventarc.GoogleApiSource;
import com.pulumi.gcp.eventarc.GoogleApiSourceArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        final var testProject = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .projectId("my-project-name")
            .build());
        final var testKeyRing = KmsFunctions.getKMSKeyRing(GetKMSKeyRingArgs.builder()
            .name("keyring")
            .location("us-central1")
            .build());
        final var key = KmsFunctions.getKMSCryptoKey(GetKMSCryptoKeyArgs.builder()
            .name("key")
            .keyRing(testKeyRing.applyValue(getKMSKeyRingResult -> getKMSKeyRingResult.id()))
            .build());
        var keyMember = new CryptoKeyIAMMember("keyMember", CryptoKeyIAMMemberArgs.builder()
            .cryptoKeyId(key.applyValue(getKMSCryptoKeyResult -> getKMSCryptoKeyResult.id()))
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .member(String.format("serviceAccount:service-%s@gcp-sa-eventarc.iam.gserviceaccount.com", testProject.applyValue(getProjectResult -> getProjectResult.number())))
            .build());
        var messageBus = new MessageBus("messageBus", MessageBusArgs.builder()
            .location("us-central1")
            .messageBusId("some-message-bus")
            .build());
        var primary = new GoogleApiSource("primary", GoogleApiSourceArgs.builder()
            .location("us-central1")
            .googleApiSourceId("some-google-api-source")
            .destination(messageBus.id())
            .cryptoKeyName(key.applyValue(getKMSCryptoKeyResult -> getKMSCryptoKeyResult.id()))
            .build(), CustomResourceOptions.builder()
                .dependsOn(keyMember)
                .build());
    }
}
resources:
  keyMember:
    type: gcp:kms:CryptoKeyIAMMember
    name: key_member
    properties:
      cryptoKeyId: ${key.id}
      role: roles/cloudkms.cryptoKeyEncrypterDecrypter
      member: serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com
  messageBus:
    type: gcp:eventarc:MessageBus
    name: message_bus
    properties:
      location: us-central1
      messageBusId: some-message-bus
  primary:
    type: gcp:eventarc:GoogleApiSource
    properties:
      location: us-central1
      googleApiSourceId: some-google-api-source
      destination: ${messageBus.id}
      cryptoKeyName: ${key.id}
    options:
      dependsOn:
        - ${keyMember}
variables:
  testProject:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments:
        projectId: my-project-name
  testKeyRing:
    fn::invoke:
      function: gcp:kms:getKMSKeyRing
      arguments:
        name: keyring
        location: us-central1
  key:
    fn::invoke:
      function: gcp:kms:getKMSCryptoKey
      arguments:
        name: key
        keyRing: ${testKeyRing.id}
Create GoogleApiSource Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GoogleApiSource(name: string, args: GoogleApiSourceArgs, opts?: CustomResourceOptions);@overload
def GoogleApiSource(resource_name: str,
                    args: GoogleApiSourceArgs,
                    opts: Optional[ResourceOptions] = None)
@overload
def GoogleApiSource(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    destination: Optional[str] = None,
                    google_api_source_id: Optional[str] = None,
                    location: Optional[str] = None,
                    annotations: Optional[Mapping[str, str]] = None,
                    crypto_key_name: Optional[str] = None,
                    display_name: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    logging_config: Optional[GoogleApiSourceLoggingConfigArgs] = None,
                    project: Optional[str] = None)func NewGoogleApiSource(ctx *Context, name string, args GoogleApiSourceArgs, opts ...ResourceOption) (*GoogleApiSource, error)public GoogleApiSource(string name, GoogleApiSourceArgs args, CustomResourceOptions? opts = null)
public GoogleApiSource(String name, GoogleApiSourceArgs args)
public GoogleApiSource(String name, GoogleApiSourceArgs args, CustomResourceOptions options)
type: gcp:eventarc:GoogleApiSource
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 GoogleApiSourceArgs
- 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 GoogleApiSourceArgs
- 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 GoogleApiSourceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GoogleApiSourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GoogleApiSourceArgs
- 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 googleApiSourceResource = new Gcp.Eventarc.GoogleApiSource("googleApiSourceResource", new()
{
    Destination = "string",
    GoogleApiSourceId = "string",
    Location = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    CryptoKeyName = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LoggingConfig = new Gcp.Eventarc.Inputs.GoogleApiSourceLoggingConfigArgs
    {
        LogSeverity = "string",
    },
    Project = "string",
});
example, err := eventarc.NewGoogleApiSource(ctx, "googleApiSourceResource", &eventarc.GoogleApiSourceArgs{
	Destination:       pulumi.String("string"),
	GoogleApiSourceId: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CryptoKeyName: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LoggingConfig: &eventarc.GoogleApiSourceLoggingConfigArgs{
		LogSeverity: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})
var googleApiSourceResource = new GoogleApiSource("googleApiSourceResource", GoogleApiSourceArgs.builder()
    .destination("string")
    .googleApiSourceId("string")
    .location("string")
    .annotations(Map.of("string", "string"))
    .cryptoKeyName("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .loggingConfig(GoogleApiSourceLoggingConfigArgs.builder()
        .logSeverity("string")
        .build())
    .project("string")
    .build());
google_api_source_resource = gcp.eventarc.GoogleApiSource("googleApiSourceResource",
    destination="string",
    google_api_source_id="string",
    location="string",
    annotations={
        "string": "string",
    },
    crypto_key_name="string",
    display_name="string",
    labels={
        "string": "string",
    },
    logging_config={
        "log_severity": "string",
    },
    project="string")
const googleApiSourceResource = new gcp.eventarc.GoogleApiSource("googleApiSourceResource", {
    destination: "string",
    googleApiSourceId: "string",
    location: "string",
    annotations: {
        string: "string",
    },
    cryptoKeyName: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    loggingConfig: {
        logSeverity: "string",
    },
    project: "string",
});
type: gcp:eventarc:GoogleApiSource
properties:
    annotations:
        string: string
    cryptoKeyName: string
    destination: string
    displayName: string
    googleApiSourceId: string
    labels:
        string: string
    location: string
    loggingConfig:
        logSeverity: string
    project: string
GoogleApiSource 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 GoogleApiSource resource accepts the following input properties:
- Destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- GoogleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- Location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- Annotations Dictionary<string, string>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- CryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- DisplayName string
- Resource display name.
- Labels Dictionary<string, string>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- LoggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- GoogleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- Location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- Annotations map[string]string
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- CryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- DisplayName string
- Resource display name.
- Labels map[string]string
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- LoggingConfig GoogleApi Source Logging Config Args 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- destination String
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- googleApi StringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- location String
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- annotations Map<String,String>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- cryptoKey StringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- displayName String
- Resource display name.
- labels Map<String,String>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- loggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- googleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- annotations {[key: string]: string}
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- cryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- displayName string
- Resource display name.
- labels {[key: string]: string}
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- loggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- destination str
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- google_api_ strsource_ id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- location str
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- annotations Mapping[str, str]
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- crypto_key_ strname 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- display_name str
- Resource display name.
- labels Mapping[str, str]
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- logging_config GoogleApi Source Logging Config Args 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- destination String
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- googleApi StringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- location String
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- annotations Map<String>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- cryptoKey StringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- displayName String
- Resource display name.
- labels Map<String>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- loggingConfig Property Map
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the GoogleApiSource resource produces the following output properties:
- CreateTime string
- The creation time.
- EffectiveAnnotations Dictionary<string, string>
- EffectiveLabels Dictionary<string, string>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- PulumiLabels Dictionary<string, string>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- UpdateTime string
- The last-modified time.
- CreateTime string
- The creation time.
- EffectiveAnnotations map[string]string
- EffectiveLabels map[string]string
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- PulumiLabels map[string]string
- The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- UpdateTime string
- The last-modified time.
- createTime String
- The creation time.
- effectiveAnnotations Map<String,String>
- effectiveLabels Map<String,String>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag String
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- pulumiLabels Map<String,String>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime String
- The last-modified time.
- createTime string
- The creation time.
- effectiveAnnotations {[key: string]: string}
- effectiveLabels {[key: string]: string}
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- pulumiLabels {[key: string]: string}
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime string
- The last-modified time.
- create_time str
- The creation time.
- effective_annotations Mapping[str, str]
- effective_labels Mapping[str, str]
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag str
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- pulumi_labels Mapping[str, str]
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid str
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_time str
- The last-modified time.
- createTime String
- The creation time.
- effectiveAnnotations Map<String>
- effectiveLabels Map<String>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag String
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- pulumiLabels Map<String>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime String
- The last-modified time.
Look up Existing GoogleApiSource Resource
Get an existing GoogleApiSource 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?: GoogleApiSourceState, opts?: CustomResourceOptions): GoogleApiSource@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        create_time: Optional[str] = None,
        crypto_key_name: Optional[str] = None,
        destination: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        etag: Optional[str] = None,
        google_api_source_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        logging_config: Optional[GoogleApiSourceLoggingConfigArgs] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> GoogleApiSourcefunc GetGoogleApiSource(ctx *Context, name string, id IDInput, state *GoogleApiSourceState, opts ...ResourceOption) (*GoogleApiSource, error)public static GoogleApiSource Get(string name, Input<string> id, GoogleApiSourceState? state, CustomResourceOptions? opts = null)public static GoogleApiSource get(String name, Output<String> id, GoogleApiSourceState state, CustomResourceOptions options)resources:  _:    type: gcp:eventarc:GoogleApiSource    get:      id: ${id}- 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.
- Annotations Dictionary<string, string>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- CreateTime string
- The creation time.
- CryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- Destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- DisplayName string
- Resource display name.
- EffectiveAnnotations Dictionary<string, string>
- EffectiveLabels Dictionary<string, string>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- GoogleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- Labels Dictionary<string, string>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- Location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- LoggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- Name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- PulumiLabels Dictionary<string, string>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- UpdateTime string
- The last-modified time.
- Annotations map[string]string
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- CreateTime string
- The creation time.
- CryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- Destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- DisplayName string
- Resource display name.
- EffectiveAnnotations map[string]string
- EffectiveLabels map[string]string
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- GoogleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- Labels map[string]string
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- Location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- LoggingConfig GoogleApi Source Logging Config Args 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- Name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- PulumiLabels map[string]string
- The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- UpdateTime string
- The last-modified time.
- annotations Map<String,String>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- createTime String
- The creation time.
- cryptoKey StringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- destination String
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- displayName String
- Resource display name.
- effectiveAnnotations Map<String,String>
- effectiveLabels Map<String,String>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag String
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- googleApi StringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- labels Map<String,String>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- location String
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- loggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- name String
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumiLabels Map<String,String>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime String
- The last-modified time.
- annotations {[key: string]: string}
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- createTime string
- The creation time.
- cryptoKey stringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- destination string
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- displayName string
- Resource display name.
- effectiveAnnotations {[key: string]: string}
- effectiveLabels {[key: string]: string}
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag string
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- googleApi stringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- labels {[key: string]: string}
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- location string
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- loggingConfig GoogleApi Source Logging Config 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- name string
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumiLabels {[key: string]: string}
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid string
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime string
- The last-modified time.
- annotations Mapping[str, str]
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- create_time str
- The creation time.
- crypto_key_ strname 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- destination str
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- display_name str
- Resource display name.
- effective_annotations Mapping[str, str]
- effective_labels Mapping[str, str]
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag str
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- google_api_ strsource_ id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- labels Mapping[str, str]
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- location str
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- logging_config GoogleApi Source Logging Config Args 
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- name str
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_labels Mapping[str, str]
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid str
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_time str
- The last-modified time.
- annotations Map<String>
- Resource annotations.
Note: This field is non-authoritative, and will only manage the annotations present in your configuration.
Please refer to the field effective_annotationsfor all of the annotations present on the resource.
- createTime String
- The creation time.
- cryptoKey StringName 
- Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.
- destination String
- Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- displayName String
- Resource display name.
- effectiveAnnotations Map<String>
- effectiveLabels Map<String>
- All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- etag String
- This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- googleApi StringSource Id 
- The user-provided ID to be assigned to the GoogleApiSource. It should match
the format ^a-z?$.
- labels Map<String>
- Resource labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field effective_labelsfor all of the labels present on the resource.
- location String
- Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
- loggingConfig Property Map
- The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
- name String
- Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumiLabels Map<String>
- The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- updateTime String
- The last-modified time.
Supporting Types
GoogleApiSourceLoggingConfig, GoogleApiSourceLoggingConfigArgs          
- LogSeverity string
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
- LogSeverity string
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
- logSeverity String
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
- logSeverity string
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
- log_severity str
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
- logSeverity String
- The minimum severity of logs that will be sent to Stackdriver/Platform
Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
Possible values are: NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.
Import
GoogleApiSource can be imported using any of these accepted formats:
- projects/{{project}}/locations/{{location}}/googleApiSources/{{google_api_source_id}}
- {{project}}/{{location}}/{{google_api_source_id}}
- {{location}}/{{google_api_source_id}}
When using the pulumi import command, GoogleApiSource can be imported using one of the formats above. For example:
$ pulumi import gcp:eventarc/googleApiSource:GoogleApiSource default projects/{{project}}/locations/{{location}}/googleApiSources/{{google_api_source_id}}
$ pulumi import gcp:eventarc/googleApiSource:GoogleApiSource default {{project}}/{{location}}/{{google_api_source_id}}
$ pulumi import gcp:eventarc/googleApiSource:GoogleApiSource default {{location}}/{{google_api_source_id}}
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-betaTerraform Provider.