SaaS class

A Saas resource is the top-level representation of a SaaS service managed by a producer. It contains a list of locations where the service is available, which is used by the Rollout system to generate a rollout plan.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

Example Usage

Saas Runtime Saas Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.saasruntime.SaaS("example", {
    saasId: "test-saas",
    location: "global",
    locations: [
        {
            name: "us-central1",
        },
        {
            name: "europe-west1",
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

example = gcp.saasruntime.SaaS("example",
    saas_id="test-saas",
    location="global",
    locations=[
        {
            "name": "us-central1",
        },
        {
            "name": "europe-west1",
        },
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.SaaSRuntime.SaaS("example", new()
    {
        SaasId = "test-saas",
        Location = "global",
        Locations = new[]
        {
            new Gcp.SaaSRuntime.Inputs.SaaSLocationArgs
            {
                Name = "us-central1",
            },
            new Gcp.SaaSRuntime.Inputs.SaaSLocationArgs
            {
                Name = "europe-west1",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/saasruntime"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := saasruntime.NewSaaS(ctx, "example", &saasruntime.SaaSArgs{
			SaasId:   pulumi.String("test-saas"),
			Location: pulumi.String("global"),
			Locations: saasruntime.SaaSLocationArray{
				&saasruntime.SaaSLocationArgs{
					Name: pulumi.String("us-central1"),
				},
				&saasruntime.SaaSLocationArgs{
					Name: pulumi.String("europe-west1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_saasruntime_saas" "example" {
  saas_id  = "test-saas"
  location = "global"
  locations {
    name = "us-central1"
  }
  locations {
    name = "europe-west1"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.saasruntime.SaaS;
import com.pulumi.gcp.saasruntime.SaaSArgs;
import com.pulumi.gcp.saasruntime.inputs.SaaSLocationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new SaaS("example", SaaSArgs.builder()
            .saasId("test-saas")
            .location("global")
            .locations(
                SaaSLocationArgs.builder()
                    .name("us-central1")
                    .build(),
                SaaSLocationArgs.builder()
                    .name("europe-west1")
                    .build())
            .build());

    }
}

resources:
  example:
    type: gcp:saasruntime:SaaS
    properties:
      saasId: test-saas
      location: global
      locations:
        - name: us-central1
        - name: europe-west1

Import

Saas can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/saas/{{saas_id}}
• {{project}}/{{location}}/{{saas_id}}
• {{location}}/{{saas_id}}

When using the pulumi import command, Saas can be imported using one of the formats above. For example:

$ pulumi import gcp:saasruntime/saaS:SaaS default projects/{{project}}/locations/{{location}}/saas/{{saas_id}}
$ pulumi import gcp:saasruntime/saaS:SaaS default {{project}}/{{location}}/{{saas_id}}
$ pulumi import gcp:saasruntime/saaS:SaaS default {{location}}/{{saas_id}}

Constructors

SaaS(String name, {SaaSArgs? args, CustomResourceOptions? options})

Creates a new SaaS. name The Pulumi resource name. args Arguments used to configure this SaaS. The set of arguments for SaaS. options Resource options controlling this resource's behavior.

SaaS.reference(String urn)

Creates a typed reference to an existing SaaS resource.

Properties

annotations ↔ Output<Map<String, String>?>

Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when the resource was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

effectiveAnnotations ↔ Output<Map<String, String>>

All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.

late, final

effectiveLabels ↔ Output<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.

late, final

etag ↔ Output<String>

An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

late, final

location ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

locations ↔ Output<List<SaaSLocation>?>

List of locations that the service is available in. Rollout refers to the list to generate a rollout plan. Structure is documented below.

late, final

name ↔ Output<String>

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}"

late, final

project ↔ Output<String>

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

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

saasId ↔ Output<String>

The ID value for the new saas.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

late, final

updateTime ↔ Output<String>

The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {SaaSState? state, CustomResourceOptions? options}) → SaaS

Gets an existing SaaS resource's state with the given name and id.