Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

Rollout

Creates a new Rollout in a given project and location. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Create Rollout Resource

new Rollout(name: string, args: RolloutArgs, opts?: CustomResourceOptions);
@overload
def Rollout(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,
            release_id: Optional[str] = None,
            request_id: Optional[str] = None,
            rollout_id: Optional[str] = None,
            target_id: Optional[str] = None,
            validate_only: Optional[bool] = None)
@overload
def Rollout(resource_name: str,
            args: RolloutArgs,
            opts: Optional[ResourceOptions] = None)
func NewRollout(ctx *Context, name string, args RolloutArgs, opts ...ResourceOption) (*Rollout, error)
public Rollout(string name, RolloutArgs args, CustomResourceOptions? opts = null)
public Rollout(String name, RolloutArgs args)
public Rollout(String name, RolloutArgs args, CustomResourceOptions options)
type: google-native:clouddeploy/v1:Rollout
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

Rollout 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 Rollout resource accepts the following input properties:

DeliveryPipelineId string
ReleaseId string
RolloutId string

Required. ID of the Rollout.

TargetId string

The ID of Target to which this Rollout is deploying.

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 Rollout for user purposes. 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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

ValidateOnly bool

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
ReleaseId string
RolloutId string

Required. ID of the Rollout.

TargetId string

The ID of Target to which this Rollout is deploying.

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 Rollout for user purposes. 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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

ValidateOnly bool

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
releaseId String
rolloutId String

Required. ID of the Rollout.

targetId String

The ID of Target to which this Rollout is deploying.

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 Rollout for user purposes. 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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

validateOnly Boolean

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
releaseId string
rolloutId string

Required. ID of the Rollout.

targetId string

The ID of Target to which this Rollout is deploying.

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 Rollout for user purposes. 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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

validateOnly boolean

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
release_id str
rollout_id str

Required. ID of the Rollout.

target_id str

The ID of Target to which this Rollout is deploying.

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 Rollout for user purposes. 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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

validate_only bool

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
releaseId String
rolloutId String

Required. ID of the Rollout.

targetId String

The ID of Target to which this Rollout is deploying.

annotations Map<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 Rollout for user purposes. 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>

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 Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/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).

validateOnly Boolean

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 Rollout resource produces the following output properties:

ApprovalState string

Approval state of the Rollout.

ApproveTime string

Time at which the Rollout was approved.

CreateTime string

Time at which the Rollout was created.

DeployEndTime string

Time at which the Rollout finished deploying.

DeployFailureCause string

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

DeployStartTime string

Time at which the Rollout started deploying.

DeployingBuild string

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

EnqueueTime string

Time at which the Rollout was enqueued.

FailureReason string

Additional information about the rollout failure, if available.

Id string

The provider-assigned unique ID for this managed resource.

Metadata Pulumi.GoogleNative.CloudDeploy.V1.Outputs.MetadataResponse

Metadata contains information about the rollout.

Phases List<Pulumi.GoogleNative.CloudDeploy.V1.Outputs.PhaseResponse>

The phases that represent the workflows of this Rollout.

State string

Current state of the Rollout.

Uid string

Unique identifier of the Rollout.

ApprovalState string

Approval state of the Rollout.

ApproveTime string

Time at which the Rollout was approved.

CreateTime string

Time at which the Rollout was created.

DeployEndTime string

Time at which the Rollout finished deploying.

DeployFailureCause string

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

DeployStartTime string

Time at which the Rollout started deploying.

DeployingBuild string

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

EnqueueTime string

Time at which the Rollout was enqueued.

FailureReason string

Additional information about the rollout failure, if available.

Id string

The provider-assigned unique ID for this managed resource.

Metadata MetadataResponse

Metadata contains information about the rollout.

Phases []PhaseResponse

The phases that represent the workflows of this Rollout.

State string

Current state of the Rollout.

Uid string

Unique identifier of the Rollout.

approvalState String

Approval state of the Rollout.

approveTime String

Time at which the Rollout was approved.

createTime String

Time at which the Rollout was created.

deployEndTime String

Time at which the Rollout finished deploying.

deployFailureCause String

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

deployStartTime String

Time at which the Rollout started deploying.

deployingBuild String

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

enqueueTime String

Time at which the Rollout was enqueued.

failureReason String

Additional information about the rollout failure, if available.

id String

The provider-assigned unique ID for this managed resource.

metadata MetadataResponse

Metadata contains information about the rollout.

phases List<PhaseResponse>

The phases that represent the workflows of this Rollout.

state String

Current state of the Rollout.

uid String

Unique identifier of the Rollout.

approvalState string

Approval state of the Rollout.

approveTime string

Time at which the Rollout was approved.

createTime string

Time at which the Rollout was created.

deployEndTime string

Time at which the Rollout finished deploying.

deployFailureCause string

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

deployStartTime string

Time at which the Rollout started deploying.

deployingBuild string

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

enqueueTime string

Time at which the Rollout was enqueued.

failureReason string

Additional information about the rollout failure, if available.

id string

The provider-assigned unique ID for this managed resource.

metadata MetadataResponse

Metadata contains information about the rollout.

phases PhaseResponse[]

The phases that represent the workflows of this Rollout.

state string

Current state of the Rollout.

uid string

Unique identifier of the Rollout.

approval_state str

Approval state of the Rollout.

approve_time str

Time at which the Rollout was approved.

create_time str

Time at which the Rollout was created.

deploy_end_time str

Time at which the Rollout finished deploying.

deploy_failure_cause str

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

deploy_start_time str

Time at which the Rollout started deploying.

deploying_build str

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

enqueue_time str

Time at which the Rollout was enqueued.

failure_reason str

Additional information about the rollout failure, if available.

id str

The provider-assigned unique ID for this managed resource.

metadata MetadataResponse

Metadata contains information about the rollout.

phases Sequence[PhaseResponse]

The phases that represent the workflows of this Rollout.

state str

Current state of the Rollout.

uid str

Unique identifier of the Rollout.

approvalState String

Approval state of the Rollout.

approveTime String

Time at which the Rollout was approved.

createTime String

Time at which the Rollout was created.

deployEndTime String

Time at which the Rollout finished deploying.

deployFailureCause String

The reason this rollout failed. This will always be unspecified while the rollout is in progress.

deployStartTime String

Time at which the Rollout started deploying.

deployingBuild String

The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

enqueueTime String

Time at which the Rollout was enqueued.

failureReason String

Additional information about the rollout failure, if available.

id String

The provider-assigned unique ID for this managed resource.

metadata Property Map

Metadata contains information about the rollout.

phases List<Property Map>

The phases that represent the workflows of this Rollout.

state String

Current state of the Rollout.

uid String

Unique identifier of the Rollout.

Supporting Types

CloudRunMetadataResponse

Revision string

The Cloud Run Revision id associated with a Rollout.

Service string

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

ServiceUrls List<string>

The Cloud Run Service urls that are associated with a Rollout.

Revision string

The Cloud Run Revision id associated with a Rollout.

Service string

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

ServiceUrls []string

The Cloud Run Service urls that are associated with a Rollout.

revision String

The Cloud Run Revision id associated with a Rollout.

service String

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

serviceUrls List<String>

The Cloud Run Service urls that are associated with a Rollout.

revision string

The Cloud Run Revision id associated with a Rollout.

service string

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

serviceUrls string[]

The Cloud Run Service urls that are associated with a Rollout.

revision str

The Cloud Run Revision id associated with a Rollout.

service str

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

service_urls Sequence[str]

The Cloud Run Service urls that are associated with a Rollout.

revision String

The Cloud Run Revision id associated with a Rollout.

service String

The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

serviceUrls List<String>

The Cloud Run Service urls that are associated with a Rollout.

DeploymentJobsResponse

DeployJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse

The deploy Job. This is the first job run in the phase.

VerifyJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse

The verify Job. Runs after a deploy if the deploy succeeds.

DeployJob JobResponse

The deploy Job. This is the first job run in the phase.

VerifyJob JobResponse

The verify Job. Runs after a deploy if the deploy succeeds.

deployJob JobResponse

The deploy Job. This is the first job run in the phase.

verifyJob JobResponse

The verify Job. Runs after a deploy if the deploy succeeds.

deployJob JobResponse

The deploy Job. This is the first job run in the phase.

verifyJob JobResponse

The verify Job. Runs after a deploy if the deploy succeeds.

deploy_job JobResponse

The deploy Job. This is the first job run in the phase.

verify_job JobResponse

The verify Job. Runs after a deploy if the deploy succeeds.

deployJob Property Map

The deploy Job. This is the first job run in the phase.

verifyJob Property Map

The verify Job. Runs after a deploy if the deploy succeeds.

JobResponse

DeployJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeployJobResponse

A deploy Job.

JobRun string

The name of the JobRun responsible for the most recent invocation of this Job.

State string

The current state of the Job.

VerifyJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.VerifyJobResponse

A verify Job.

DeployJob DeployJobResponse

A deploy Job.

JobRun string

The name of the JobRun responsible for the most recent invocation of this Job.

State string

The current state of the Job.

VerifyJob VerifyJobResponse

A verify Job.

deployJob DeployJobResponse

A deploy Job.

jobRun String

The name of the JobRun responsible for the most recent invocation of this Job.

state String

The current state of the Job.

verifyJob VerifyJobResponse

A verify Job.

deployJob DeployJobResponse

A deploy Job.

jobRun string

The name of the JobRun responsible for the most recent invocation of this Job.

state string

The current state of the Job.

verifyJob VerifyJobResponse

A verify Job.

deploy_job DeployJobResponse

A deploy Job.

job_run str

The name of the JobRun responsible for the most recent invocation of this Job.

state str

The current state of the Job.

verify_job VerifyJobResponse

A verify Job.

deployJob Property Map

A deploy Job.

jobRun String

The name of the JobRun responsible for the most recent invocation of this Job.

state String

The current state of the Job.

verifyJob Property Map

A verify Job.

MetadataResponse

CloudRun Pulumi.GoogleNative.CloudDeploy.V1.Inputs.CloudRunMetadataResponse

The name of the Cloud Run Service that is associated with a Rollout.

CloudRun CloudRunMetadataResponse

The name of the Cloud Run Service that is associated with a Rollout.

cloudRun CloudRunMetadataResponse

The name of the Cloud Run Service that is associated with a Rollout.

cloudRun CloudRunMetadataResponse

The name of the Cloud Run Service that is associated with a Rollout.

cloud_run CloudRunMetadataResponse

The name of the Cloud Run Service that is associated with a Rollout.

cloudRun Property Map

The name of the Cloud Run Service that is associated with a Rollout.

PhaseResponse

DeploymentJobs Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeploymentJobsResponse

Deployment job composition.

State string

Current state of the Phase.

DeploymentJobs DeploymentJobsResponse

Deployment job composition.

State string

Current state of the Phase.

deploymentJobs DeploymentJobsResponse

Deployment job composition.

state String

Current state of the Phase.

deploymentJobs DeploymentJobsResponse

Deployment job composition.

state string

Current state of the Phase.

deployment_jobs DeploymentJobsResponse

Deployment job composition.

state str

Current state of the Phase.

deploymentJobs Property Map

Deployment job composition.

state String

Current state of the Phase.

Package Details

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