Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Thursday, May 19, 2022 by Pulumi

DeliveryPipeline

Creates a new DeliveryPipeline in a given project and location. Auto-naming is currently not supported for this resource.

Create a DeliveryPipeline Resource

new DeliveryPipeline(name: string, args: DeliveryPipelineArgs, opts?: CustomResourceOptions);
@overload
def DeliveryPipeline(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     annotations: Optional[Mapping[str, str]] = None,
                     delivery_pipeline_id: Optional[str] = None,
                     description: Optional[str] = None,
                     etag: Optional[str] = None,
                     labels: Optional[Mapping[str, str]] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     project: Optional[str] = None,
                     request_id: Optional[str] = None,
                     serial_pipeline: Optional[SerialPipelineArgs] = None,
                     validate_only: Optional[str] = None)
@overload
def DeliveryPipeline(resource_name: str,
                     args: DeliveryPipelineArgs,
                     opts: Optional[ResourceOptions] = None)
func NewDeliveryPipeline(ctx *Context, name string, args DeliveryPipelineArgs, opts ...ResourceOption) (*DeliveryPipeline, error)
public DeliveryPipeline(string name, DeliveryPipelineArgs args, CustomResourceOptions? opts = null)
public DeliveryPipeline(String name, DeliveryPipelineArgs args)
public DeliveryPipeline(String name, DeliveryPipelineArgs args, CustomResourceOptions options)
type: google-native:clouddeploy/v1:DeliveryPipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

DeliveryPipeline Resource Properties

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

Inputs

The DeliveryPipeline resource accepts the following input properties:

DeliveryPipelineId string

Required. ID of the DeliveryPipeline.

Annotations Dictionary<string, string>

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Description string

Description of the DeliveryPipeline. Max length is 255 characters.

Etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Labels Dictionary<string, string>

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

Location string
Name string

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

Project string
RequestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

SerialPipeline Pulumi.GoogleNative.CloudDeploy.V1.Inputs.SerialPipelineArgs

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

ValidateOnly string

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

DeliveryPipelineId string

Required. ID of the DeliveryPipeline.

Annotations map[string]string

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Description string

Description of the DeliveryPipeline. Max length is 255 characters.

Etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Labels map[string]string

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

Location string
Name string

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

Project string
RequestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

SerialPipeline SerialPipelineArgs

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

ValidateOnly string

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

deliveryPipelineId String

Required. ID of the DeliveryPipeline.

annotations Map

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

description String

Description of the DeliveryPipeline. Max length is 255 characters.

etag String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels Map

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

location String
name String

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

project String
requestId String

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

serialPipeline SerialPipelineArgs

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

validateOnly String

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

deliveryPipelineId string

Required. ID of the DeliveryPipeline.

annotations {[key: string]: string}

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

description string

Description of the DeliveryPipeline. Max length is 255 characters.

etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels {[key: string]: string}

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

location string
name string

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

project string
requestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

serialPipeline SerialPipelineArgs

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

validateOnly string

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

delivery_pipeline_id str

Required. ID of the DeliveryPipeline.

annotations Mapping[str, str]

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

description str

Description of the DeliveryPipeline. Max length is 255 characters.

etag str

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels Mapping[str, str]

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

location str
name str

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

project str
request_id str

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

serial_pipeline SerialPipelineArgs

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

validate_only str

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

deliveryPipelineId String

Required. ID of the DeliveryPipeline.

annotations Map

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

description String

Description of the DeliveryPipeline. Max length is 255 characters.

etag String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels Map

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

location String
name String

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

project String
requestId String

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

serialPipeline Property Map

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

validateOnly String

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeliveryPipeline resource produces the following output properties:

Condition Pulumi.GoogleNative.CloudDeploy.V1.Outputs.PipelineConditionResponse

Information around the state of the Delivery Pipeline.

CreateTime string

Time at which the pipeline was created.

Id string

The provider-assigned unique ID for this managed resource.

Uid string

Unique identifier of the DeliveryPipeline.

UpdateTime string

Most recent time at which the pipeline was updated.

Condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

CreateTime string

Time at which the pipeline was created.

Id string

The provider-assigned unique ID for this managed resource.

Uid string

Unique identifier of the DeliveryPipeline.

UpdateTime string

Most recent time at which the pipeline was updated.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

createTime String

Time at which the pipeline was created.

id String

The provider-assigned unique ID for this managed resource.

uid String

Unique identifier of the DeliveryPipeline.

updateTime String

Most recent time at which the pipeline was updated.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

createTime string

Time at which the pipeline was created.

id string

The provider-assigned unique ID for this managed resource.

uid string

Unique identifier of the DeliveryPipeline.

updateTime string

Most recent time at which the pipeline was updated.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

create_time str

Time at which the pipeline was created.

id str

The provider-assigned unique ID for this managed resource.

uid str

Unique identifier of the DeliveryPipeline.

update_time str

Most recent time at which the pipeline was updated.

condition Property Map

Information around the state of the Delivery Pipeline.

createTime String

Time at which the pipeline was created.

id String

The provider-assigned unique ID for this managed resource.

uid String

Unique identifier of the DeliveryPipeline.

updateTime String

Most recent time at which the pipeline was updated.

Supporting Types

PipelineConditionResponse

PipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

TargetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipeline_ready_condition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targets_present_condition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition Property Map

Details around the Pipeline's overall status.

targetsPresentCondition Property Map

Detalis around targets enumerated in the pipeline.

PipelineReadyConditionResponse

Status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

UpdateTime string

Last time the condition was updated.

Status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

UpdateTime string

Last time the condition was updated.

status Boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime String

Last time the condition was updated.

status boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime string

Last time the condition was updated.

status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

update_time str

Last time the condition was updated.

status Boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime String

Last time the condition was updated.

SerialPipeline

Stages List<Pulumi.GoogleNative.CloudDeploy.V1.Inputs.Stage>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Stages []Stage

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages List

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages Stage[]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages Sequence[Stage]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages List

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

SerialPipelineResponse

Stages List<Pulumi.GoogleNative.CloudDeploy.V1.Inputs.StageResponse>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Stages []StageResponse

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages ListResponse>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages StageResponse[]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages Sequence[StageResponse]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages List

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Stage

Profiles List<string>

Skaffold profiles to use when rendering the manifest for this stage's Target.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

Profiles []string

Skaffold profiles to use when rendering the manifest for this stage's Target.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles string[]

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles Sequence[str]

Skaffold profiles to use when rendering the manifest for this stage's Target.

target_id str

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

StageResponse

Profiles List<string>

Skaffold profiles to use when rendering the manifest for this stage's Target.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

Profiles []string

Skaffold profiles to use when rendering the manifest for this stage's Target.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles string[]

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles Sequence[str]

Skaffold profiles to use when rendering the manifest for this stage's Target.

target_id str

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List

Skaffold profiles to use when rendering the manifest for this stage's Target.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

TargetsPresentConditionResponse

MissingTargets List<string>

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

Status bool

True if there aren't any missing Targets.

UpdateTime string

Last time the condition was updated.

MissingTargets []string

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

Status bool

True if there aren't any missing Targets.

UpdateTime string

Last time the condition was updated.

missingTargets List

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status Boolean

True if there aren't any missing Targets.

updateTime String

Last time the condition was updated.

missingTargets string[]

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status boolean

True if there aren't any missing Targets.

updateTime string

Last time the condition was updated.

missing_targets Sequence[str]

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status bool

True if there aren't any missing Targets.

update_time str

Last time the condition was updated.

missingTargets List

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status Boolean

True if there aren't any missing Targets.

updateTime String

Last time the condition was updated.

Package Details

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