@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
421 lines • 19.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A UnitKind serves as a template or type definition for a group of Units. Units that belong to the same UnitKind are managed together, follow the same release model, and are typically updated together through rollouts.
*
* > **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 Unit Kind Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const exampleSaas = new gcp.saasruntime.SaaS("example_saas", {
* saasId: "example-saas",
* location: "us-east1",
* locations: [{
* name: "us-east1",
* }],
* });
* const clusterUnitKind = new gcp.saasruntime.UnitKind("cluster_unit_kind", {
* location: "us-east1",
* unitKindId: "cluster-unitkind",
* saas: exampleSaas.id,
* defaultRelease: "projects/my-project-name/locations/us-east1/releases/example-release",
* });
* const example = new gcp.saasruntime.UnitKind("example", {
* location: "us-east1",
* unitKindId: "app-unitkind",
* saas: exampleSaas.id,
* dependencies: [{
* unitKind: clusterUnitKind.id,
* alias: "cluster",
* }],
* });
* const exampleRelease = new gcp.saasruntime.Release("example_release", {
* location: "us-east1",
* releaseId: "example-release",
* unitKind: clusterUnitKind.id,
* blueprint: {
* "package": "us-central1-docker.pkg.dev/ci-test-project-188019/test-repo/tf-test-easysaas-alpha-image@sha256:7992fdbaeaf998ecd31a7f937bb26e38a781ecf49b24857a6176c1e9bfc299ee",
* },
* });
* ```
*
* ## Import
*
* UnitKind can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/unitKinds/{{unit_kind_id}}`
* * `{{project}}/{{location}}/{{unit_kind_id}}`
* * `{{location}}/{{unit_kind_id}}`
*
* When using the `pulumi import` command, UnitKind can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:saasruntime/unitKind:UnitKind default projects/{{project}}/locations/{{location}}/unitKinds/{{unit_kind_id}}
* $ pulumi import gcp:saasruntime/unitKind:UnitKind default {{project}}/{{location}}/{{unit_kind_id}}
* $ pulumi import gcp:saasruntime/unitKind:UnitKind default {{location}}/{{unit_kind_id}}
* ```
*/
export declare class UnitKind extends pulumi.CustomResource {
/**
* Get an existing UnitKind resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UnitKindState, opts?: pulumi.CustomResourceOptions): UnitKind;
/**
* Returns true if the given object is an instance of UnitKind. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is UnitKind;
/**
* 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.
*/
readonly annotations: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The timestamp when the resource was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* A reference to the Release object to use as default for creating new units
* of this UnitKind.
* If not specified, a new unit must explicitly reference which release to use
* for its creation.
*/
readonly defaultRelease: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* List of other unit kinds that this release will depend on. Dependencies
* will be automatically provisioned if not found. Maximum 10.
* Structure is documented below.
*/
readonly dependencies: pulumi.Output<outputs.saasruntime.UnitKindDependency[] | undefined>;
/**
* All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
*/
readonly effectiveAnnotations: pulumi.Output<{
[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.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: 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.
*/
readonly etag: pulumi.Output<string>;
/**
* List of inputVariables for this release that will either be retrieved from
* a dependency’s outputVariables, or will be passed on to a dependency’s
* inputVariables. Maximum 100.
* Structure is documented below.
*/
readonly inputVariableMappings: pulumi.Output<outputs.saasruntime.UnitKindInputVariableMapping[] | undefined>;
/**
* 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.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming
* scheme:
* "projects/{project}/locations/{location}/unitKinds/{unitKind}"
*/
readonly name: pulumi.Output<string>;
/**
* List of outputVariables for this unit kind will be passed to this unit's
* outputVariables. Maximum 100.
* Structure is documented below.
*/
readonly outputVariableMappings: pulumi.Output<outputs.saasruntime.UnitKindOutputVariableMapping[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* A reference to the Saas that defines the product (managed service) that
* the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager
* common data model. Immutable once set.
*/
readonly saas: pulumi.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.
*/
readonly uid: pulumi.Output<string>;
/**
* The ID value for the new unit kind.
*/
readonly unitKindId: pulumi.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.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a UnitKind resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UnitKindArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UnitKind resources.
*/
export interface UnitKindState {
/**
* 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.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The timestamp when the resource was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* A reference to the Release object to use as default for creating new units
* of this UnitKind.
* If not specified, a new unit must explicitly reference which release to use
* for its creation.
*/
defaultRelease?: pulumi.Input<string | undefined>;
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* List of other unit kinds that this release will depend on. Dependencies
* will be automatically provisioned if not found. Maximum 10.
* Structure is documented below.
*/
dependencies?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindDependency>[] | undefined>;
/**
* All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
*/
effectiveAnnotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* 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.
*/
etag?: pulumi.Input<string | undefined>;
/**
* List of inputVariables for this release that will either be retrieved from
* a dependency’s outputVariables, or will be passed on to a dependency’s
* inputVariables. Maximum 100.
* Structure is documented below.
*/
inputVariableMappings?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindInputVariableMapping>[] | undefined>;
/**
* 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.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming
* scheme:
* "projects/{project}/locations/{location}/unitKinds/{unitKind}"
*/
name?: pulumi.Input<string | undefined>;
/**
* List of outputVariables for this unit kind will be passed to this unit's
* outputVariables. Maximum 100.
* Structure is documented below.
*/
outputVariableMappings?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindOutputVariableMapping>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* A reference to the Saas that defines the product (managed service) that
* the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager
* common data model. Immutable once set.
*/
saas?: pulumi.Input<string | undefined>;
/**
* 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.
*/
uid?: pulumi.Input<string | undefined>;
/**
* The ID value for the new unit kind.
*/
unitKindId?: pulumi.Input<string | undefined>;
/**
* 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.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a UnitKind resource.
*/
export interface UnitKindArgs {
/**
* 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.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* A reference to the Release object to use as default for creating new units
* of this UnitKind.
* If not specified, a new unit must explicitly reference which release to use
* for its creation.
*/
defaultRelease?: pulumi.Input<string | undefined>;
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* List of other unit kinds that this release will depend on. Dependencies
* will be automatically provisioned if not found. Maximum 10.
* Structure is documented below.
*/
dependencies?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindDependency>[] | undefined>;
/**
* List of inputVariables for this release that will either be retrieved from
* a dependency’s outputVariables, or will be passed on to a dependency’s
* inputVariables. Maximum 100.
* Structure is documented below.
*/
inputVariableMappings?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindInputVariableMapping>[] | undefined>;
/**
* 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.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* List of outputVariables for this unit kind will be passed to this unit's
* outputVariables. Maximum 100.
* Structure is documented below.
*/
outputVariableMappings?: pulumi.Input<pulumi.Input<inputs.saasruntime.UnitKindOutputVariableMapping>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* A reference to the Saas that defines the product (managed service) that
* the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager
* common data model. Immutable once set.
*/
saas: pulumi.Input<string>;
/**
* The ID value for the new unit kind.
*/
unitKindId: pulumi.Input<string>;
}
//# sourceMappingURL=unitKind.d.ts.map