Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. clouddeploy
  5. clouddeploy/v1
  6. Rollout

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.clouddeploy/v1.Rollout

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new Rollout in a given project and location. 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

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Rollout(name: string, args: RolloutArgs, opts?: CustomResourceOptions);
@overload
def Rollout(resource_name: str,
            args: RolloutArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Rollout(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            release_id: Optional[str] = None,
            delivery_pipeline_id: Optional[str] = None,
            target_id: Optional[str] = None,
            rollout_id: Optional[str] = None,
            name: Optional[str] = None,
            location: Optional[str] = None,
            annotations: Optional[Mapping[str, str]] = None,
            project: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            request_id: Optional[str] = None,
            etag: Optional[str] = None,
            starting_phase_id: Optional[str] = None,
            description: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RolloutArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. RolloutArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RolloutArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RolloutArgs
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 rolloutResource = new GoogleNative.CloudDeploy.V1.Rollout("rolloutResource", new()
{
    ReleaseId = "string",
    DeliveryPipelineId = "string",
    TargetId = "string",
    RolloutId = "string",
    Name = "string",
    Location = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Project = "string",
    Labels = 
    {
        { "string", "string" },
    },
    RequestId = "string",
    Etag = "string",
    StartingPhaseId = "string",
    Description = "string",
});
Copy
example, err := clouddeploy.NewRollout(ctx, "rolloutResource", &clouddeploy.RolloutArgs{
	ReleaseId:          pulumi.String("string"),
	DeliveryPipelineId: pulumi.String("string"),
	TargetId:           pulumi.String("string"),
	RolloutId:          pulumi.String("string"),
	Name:               pulumi.String("string"),
	Location:           pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RequestId:       pulumi.String("string"),
	Etag:            pulumi.String("string"),
	StartingPhaseId: pulumi.String("string"),
	Description:     pulumi.String("string"),
})
Copy
var rolloutResource = new Rollout("rolloutResource", RolloutArgs.builder()
    .releaseId("string")
    .deliveryPipelineId("string")
    .targetId("string")
    .rolloutId("string")
    .name("string")
    .location("string")
    .annotations(Map.of("string", "string"))
    .project("string")
    .labels(Map.of("string", "string"))
    .requestId("string")
    .etag("string")
    .startingPhaseId("string")
    .description("string")
    .build());
Copy
rollout_resource = google_native.clouddeploy.v1.Rollout("rolloutResource",
    release_id="string",
    delivery_pipeline_id="string",
    target_id="string",
    rollout_id="string",
    name="string",
    location="string",
    annotations={
        "string": "string",
    },
    project="string",
    labels={
        "string": "string",
    },
    request_id="string",
    etag="string",
    starting_phase_id="string",
    description="string")
Copy
const rolloutResource = new google_native.clouddeploy.v1.Rollout("rolloutResource", {
    releaseId: "string",
    deliveryPipelineId: "string",
    targetId: "string",
    rolloutId: "string",
    name: "string",
    location: "string",
    annotations: {
        string: "string",
    },
    project: "string",
    labels: {
        string: "string",
    },
    requestId: "string",
    etag: "string",
    startingPhaseId: "string",
    description: "string",
});
Copy
type: google-native:clouddeploy/v1:Rollout
properties:
    annotations:
        string: string
    deliveryPipelineId: string
    description: string
    etag: string
    labels:
        string: string
    location: string
    name: string
    project: string
    releaseId: string
    requestId: string
    rolloutId: string
    startingPhaseId: string
    targetId: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Rollout resource accepts the following input properties:

DeliveryPipelineId
This property is required.
Changes to this property will trigger replacement.
string
ReleaseId
This property is required.
Changes to this property will trigger replacement.
string
RolloutId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the Rollout.
TargetId This property is required. 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 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 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 Changes to this property will trigger replacement. string
Name string
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
Project Changes to this property will trigger replacement. 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).
StartingPhaseId string
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
DeliveryPipelineId
This property is required.
Changes to this property will trigger replacement.
string
ReleaseId
This property is required.
Changes to this property will trigger replacement.
string
RolloutId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the Rollout.
TargetId This property is required. 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 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 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 Changes to this property will trigger replacement. string
Name string
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
Project Changes to this property will trigger replacement. 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).
StartingPhaseId string
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
deliveryPipelineId
This property is required.
Changes to this property will trigger replacement.
String
releaseId
This property is required.
Changes to this property will trigger replacement.
String
rolloutId
This property is required.
Changes to this property will trigger replacement.
String
Required. ID of the Rollout.
targetId This property is required. 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 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 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 Changes to this property will trigger replacement. String
name String
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
project Changes to this property will trigger replacement. 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).
startingPhaseId String
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
deliveryPipelineId
This property is required.
Changes to this property will trigger replacement.
string
releaseId
This property is required.
Changes to this property will trigger replacement.
string
rolloutId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the Rollout.
targetId This property is required. 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 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 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 Changes to this property will trigger replacement. string
name string
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
project Changes to this property will trigger replacement. 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).
startingPhaseId string
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
delivery_pipeline_id
This property is required.
Changes to this property will trigger replacement.
str
release_id
This property is required.
Changes to this property will trigger replacement.
str
rollout_id
This property is required.
Changes to this property will trigger replacement.
str
Required. ID of the Rollout.
target_id This property is required. 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 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 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 Changes to this property will trigger replacement. str
name str
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
project Changes to this property will trigger replacement. 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).
starting_phase_id str
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
deliveryPipelineId
This property is required.
Changes to this property will trigger replacement.
String
releaseId
This property is required.
Changes to this property will trigger replacement.
String
rolloutId
This property is required.
Changes to this property will trigger replacement.
String
Required. ID of the Rollout.
targetId This property is required. 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 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 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 Changes to this property will trigger replacement. String
name String
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
project Changes to this property will trigger replacement. 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).
startingPhaseId String
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

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.
ControllerRollout string
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
RollbackOfRollout string
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
RolledBackByRollouts List<string>
Names of Rollouts that rolled back 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.
ControllerRollout string
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
RollbackOfRollout string
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
RolledBackByRollouts []string
Names of Rollouts that rolled back 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.
controllerRollout String
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
rollbackOfRollout String
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
rolledBackByRollouts List<String>
Names of Rollouts that rolled back 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.
controllerRollout string
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
rollbackOfRollout string
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
rolledBackByRollouts string[]
Names of Rollouts that rolled back 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.
controller_rollout str
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
rollback_of_rollout str
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
rolled_back_by_rollouts Sequence[str]
Names of Rollouts that rolled back 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.
controllerRollout String
Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
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.
rollbackOfRollout String
Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.
rolledBackByRollouts List<String>
Names of Rollouts that rolled back this Rollout.
state String
Current state of the Rollout.
uid String
Unique identifier of the Rollout.

Supporting Types

AutomationRolloutMetadataResponse
, AutomationRolloutMetadataResponseArgs

AdvanceAutomationRuns This property is required. List<string>
The IDs of the AutomationRuns initiated by an advance rollout rule.
PromoteAutomationRun This property is required. string
The ID of the AutomationRun initiated by a promote release rule.
RepairAutomationRuns This property is required. List<string>
The IDs of the AutomationRuns initiated by a repair rollout rule.
AdvanceAutomationRuns This property is required. []string
The IDs of the AutomationRuns initiated by an advance rollout rule.
PromoteAutomationRun This property is required. string
The ID of the AutomationRun initiated by a promote release rule.
RepairAutomationRuns This property is required. []string
The IDs of the AutomationRuns initiated by a repair rollout rule.
advanceAutomationRuns This property is required. List<String>
The IDs of the AutomationRuns initiated by an advance rollout rule.
promoteAutomationRun This property is required. String
The ID of the AutomationRun initiated by a promote release rule.
repairAutomationRuns This property is required. List<String>
The IDs of the AutomationRuns initiated by a repair rollout rule.
advanceAutomationRuns This property is required. string[]
The IDs of the AutomationRuns initiated by an advance rollout rule.
promoteAutomationRun This property is required. string
The ID of the AutomationRun initiated by a promote release rule.
repairAutomationRuns This property is required. string[]
The IDs of the AutomationRuns initiated by a repair rollout rule.
advance_automation_runs This property is required. Sequence[str]
The IDs of the AutomationRuns initiated by an advance rollout rule.
promote_automation_run This property is required. str
The ID of the AutomationRun initiated by a promote release rule.
repair_automation_runs This property is required. Sequence[str]
The IDs of the AutomationRuns initiated by a repair rollout rule.
advanceAutomationRuns This property is required. List<String>
The IDs of the AutomationRuns initiated by an advance rollout rule.
promoteAutomationRun This property is required. String
The ID of the AutomationRun initiated by a promote release rule.
repairAutomationRuns This property is required. List<String>
The IDs of the AutomationRuns initiated by a repair rollout rule.

ChildRolloutJobsResponse
, ChildRolloutJobsResponseArgs

AdvanceRolloutJobs This property is required. List<Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse>
List of AdvanceChildRolloutJobs
CreateRolloutJobs This property is required. List<Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse>
List of CreateChildRolloutJobs
AdvanceRolloutJobs This property is required. []JobResponse
List of AdvanceChildRolloutJobs
CreateRolloutJobs This property is required. []JobResponse
List of CreateChildRolloutJobs
advanceRolloutJobs This property is required. List<JobResponse>
List of AdvanceChildRolloutJobs
createRolloutJobs This property is required. List<JobResponse>
List of CreateChildRolloutJobs
advanceRolloutJobs This property is required. JobResponse[]
List of AdvanceChildRolloutJobs
createRolloutJobs This property is required. JobResponse[]
List of CreateChildRolloutJobs
advance_rollout_jobs This property is required. Sequence[JobResponse]
List of AdvanceChildRolloutJobs
create_rollout_jobs This property is required. Sequence[JobResponse]
List of CreateChildRolloutJobs
advanceRolloutJobs This property is required. List<Property Map>
List of AdvanceChildRolloutJobs
createRolloutJobs This property is required. List<Property Map>
List of CreateChildRolloutJobs

CloudRunMetadataResponse
, CloudRunMetadataResponseArgs

Job This property is required. string
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
Revision This property is required. string
The Cloud Run Revision id associated with a Rollout.
Service This property is required. string
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
ServiceUrls This property is required. List<string>
The Cloud Run Service urls that are associated with a Rollout.
Job This property is required. string
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
Revision This property is required. string
The Cloud Run Revision id associated with a Rollout.
Service This property is required. string
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
ServiceUrls This property is required. []string
The Cloud Run Service urls that are associated with a Rollout.
job This property is required. String
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
revision This property is required. String
The Cloud Run Revision id associated with a Rollout.
service This property is required. String
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls This property is required. List<String>
The Cloud Run Service urls that are associated with a Rollout.
job This property is required. string
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
revision This property is required. string
The Cloud Run Revision id associated with a Rollout.
service This property is required. string
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls This property is required. string[]
The Cloud Run Service urls that are associated with a Rollout.
job This property is required. str
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
revision This property is required. str
The Cloud Run Revision id associated with a Rollout.
service This property is required. str
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
service_urls This property is required. Sequence[str]
The Cloud Run Service urls that are associated with a Rollout.
job This property is required. String
The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.
revision This property is required. String
The Cloud Run Revision id associated with a Rollout.
service This property is required. String
The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls This property is required. List<String>
The Cloud Run Service urls that are associated with a Rollout.

DeploymentJobsResponse
, DeploymentJobsResponseArgs

DeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse
The deploy Job. This is the deploy job in the phase.
PostdeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse
The postdeploy Job, which is the last job on the phase.
PredeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse
The predeploy Job, which is the first job on the phase.
VerifyJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse
The verify Job. Runs after a deploy if the deploy succeeds.
DeployJob This property is required. JobResponse
The deploy Job. This is the deploy job in the phase.
PostdeployJob This property is required. JobResponse
The postdeploy Job, which is the last job on the phase.
PredeployJob This property is required. JobResponse
The predeploy Job, which is the first job on the phase.
VerifyJob This property is required. JobResponse
The verify Job. Runs after a deploy if the deploy succeeds.
deployJob This property is required. JobResponse
The deploy Job. This is the deploy job in the phase.
postdeployJob This property is required. JobResponse
The postdeploy Job, which is the last job on the phase.
predeployJob This property is required. JobResponse
The predeploy Job, which is the first job on the phase.
verifyJob This property is required. JobResponse
The verify Job. Runs after a deploy if the deploy succeeds.
deployJob This property is required. JobResponse
The deploy Job. This is the deploy job in the phase.
postdeployJob This property is required. JobResponse
The postdeploy Job, which is the last job on the phase.
predeployJob This property is required. JobResponse
The predeploy Job, which is the first job on the phase.
verifyJob This property is required. JobResponse
The verify Job. Runs after a deploy if the deploy succeeds.
deploy_job This property is required. JobResponse
The deploy Job. This is the deploy job in the phase.
postdeploy_job This property is required. JobResponse
The postdeploy Job, which is the last job on the phase.
predeploy_job This property is required. JobResponse
The predeploy Job, which is the first job on the phase.
verify_job This property is required. JobResponse
The verify Job. Runs after a deploy if the deploy succeeds.
deployJob This property is required. Property Map
The deploy Job. This is the deploy job in the phase.
postdeployJob This property is required. Property Map
The postdeploy Job, which is the last job on the phase.
predeployJob This property is required. Property Map
The predeploy Job, which is the first job on the phase.
verifyJob This property is required. Property Map
The verify Job. Runs after a deploy if the deploy succeeds.

JobResponse
, JobResponseArgs

AdvanceChildRolloutJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.AdvanceChildRolloutJobResponse
An advanceChildRollout Job.
CreateChildRolloutJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.CreateChildRolloutJobResponse
A createChildRollout Job.
DeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeployJobResponse
A deploy Job.
JobRun This property is required. string
The name of the JobRun responsible for the most recent invocation of this Job.
PostdeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.PostdeployJobResponse
A postdeploy Job.
PredeployJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.PredeployJobResponse
A predeploy Job.
SkipMessage This property is required. string
Additional information on why the Job was skipped, if available.
State This property is required. string
The current state of the Job.
VerifyJob This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.VerifyJobResponse
A verify Job.
AdvanceChildRolloutJob This property is required. AdvanceChildRolloutJobResponse
An advanceChildRollout Job.
CreateChildRolloutJob This property is required. CreateChildRolloutJobResponse
A createChildRollout Job.
DeployJob This property is required. DeployJobResponse
A deploy Job.
JobRun This property is required. string
The name of the JobRun responsible for the most recent invocation of this Job.
PostdeployJob This property is required. PostdeployJobResponse
A postdeploy Job.
PredeployJob This property is required. PredeployJobResponse
A predeploy Job.
SkipMessage This property is required. string
Additional information on why the Job was skipped, if available.
State This property is required. string
The current state of the Job.
VerifyJob This property is required. VerifyJobResponse
A verify Job.
advanceChildRolloutJob This property is required. AdvanceChildRolloutJobResponse
An advanceChildRollout Job.
createChildRolloutJob This property is required. CreateChildRolloutJobResponse
A createChildRollout Job.
deployJob This property is required. DeployJobResponse
A deploy Job.
jobRun This property is required. String
The name of the JobRun responsible for the most recent invocation of this Job.
postdeployJob This property is required. PostdeployJobResponse
A postdeploy Job.
predeployJob This property is required. PredeployJobResponse
A predeploy Job.
skipMessage This property is required. String
Additional information on why the Job was skipped, if available.
state This property is required. String
The current state of the Job.
verifyJob This property is required. VerifyJobResponse
A verify Job.
advanceChildRolloutJob This property is required. AdvanceChildRolloutJobResponse
An advanceChildRollout Job.
createChildRolloutJob This property is required. CreateChildRolloutJobResponse
A createChildRollout Job.
deployJob This property is required. DeployJobResponse
A deploy Job.
jobRun This property is required. string
The name of the JobRun responsible for the most recent invocation of this Job.
postdeployJob This property is required. PostdeployJobResponse
A postdeploy Job.
predeployJob This property is required. PredeployJobResponse
A predeploy Job.
skipMessage This property is required. string
Additional information on why the Job was skipped, if available.
state This property is required. string
The current state of the Job.
verifyJob This property is required. VerifyJobResponse
A verify Job.
advance_child_rollout_job This property is required. AdvanceChildRolloutJobResponse
An advanceChildRollout Job.
create_child_rollout_job This property is required. CreateChildRolloutJobResponse
A createChildRollout Job.
deploy_job This property is required. DeployJobResponse
A deploy Job.
job_run This property is required. str
The name of the JobRun responsible for the most recent invocation of this Job.
postdeploy_job This property is required. PostdeployJobResponse
A postdeploy Job.
predeploy_job This property is required. PredeployJobResponse
A predeploy Job.
skip_message This property is required. str
Additional information on why the Job was skipped, if available.
state This property is required. str
The current state of the Job.
verify_job This property is required. VerifyJobResponse
A verify Job.
advanceChildRolloutJob This property is required. Property Map
An advanceChildRollout Job.
createChildRolloutJob This property is required. Property Map
A createChildRollout Job.
deployJob This property is required. Property Map
A deploy Job.
jobRun This property is required. String
The name of the JobRun responsible for the most recent invocation of this Job.
postdeployJob This property is required. Property Map
A postdeploy Job.
predeployJob This property is required. Property Map
A predeploy Job.
skipMessage This property is required. String
Additional information on why the Job was skipped, if available.
state This property is required. String
The current state of the Job.
verifyJob This property is required. Property Map
A verify Job.

MetadataResponse
, MetadataResponseArgs

Automation This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.AutomationRolloutMetadataResponse
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
CloudRun This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.CloudRunMetadataResponse
The name of the Cloud Run Service that is associated with a Rollout.
Automation This property is required. AutomationRolloutMetadataResponse
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
CloudRun This property is required. CloudRunMetadataResponse
The name of the Cloud Run Service that is associated with a Rollout.
automation This property is required. AutomationRolloutMetadataResponse
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
cloudRun This property is required. CloudRunMetadataResponse
The name of the Cloud Run Service that is associated with a Rollout.
automation This property is required. AutomationRolloutMetadataResponse
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
cloudRun This property is required. CloudRunMetadataResponse
The name of the Cloud Run Service that is associated with a Rollout.
automation This property is required. AutomationRolloutMetadataResponse
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
cloud_run This property is required. CloudRunMetadataResponse
The name of the Cloud Run Service that is associated with a Rollout.
automation This property is required. Property Map
AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
cloudRun This property is required. Property Map
The name of the Cloud Run Service that is associated with a Rollout.

PhaseResponse
, PhaseResponseArgs

ChildRolloutJobs This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.ChildRolloutJobsResponse
ChildRollout job composition.
DeploymentJobs This property is required. Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeploymentJobsResponse
Deployment job composition.
SkipMessage This property is required. string
Additional information on why the Phase was skipped, if available.
State This property is required. string
Current state of the Phase.
ChildRolloutJobs This property is required. ChildRolloutJobsResponse
ChildRollout job composition.
DeploymentJobs This property is required. DeploymentJobsResponse
Deployment job composition.
SkipMessage This property is required. string
Additional information on why the Phase was skipped, if available.
State This property is required. string
Current state of the Phase.
childRolloutJobs This property is required. ChildRolloutJobsResponse
ChildRollout job composition.
deploymentJobs This property is required. DeploymentJobsResponse
Deployment job composition.
skipMessage This property is required. String
Additional information on why the Phase was skipped, if available.
state This property is required. String
Current state of the Phase.
childRolloutJobs This property is required. ChildRolloutJobsResponse
ChildRollout job composition.
deploymentJobs This property is required. DeploymentJobsResponse
Deployment job composition.
skipMessage This property is required. string
Additional information on why the Phase was skipped, if available.
state This property is required. string
Current state of the Phase.
child_rollout_jobs This property is required. ChildRolloutJobsResponse
ChildRollout job composition.
deployment_jobs This property is required. DeploymentJobsResponse
Deployment job composition.
skip_message This property is required. str
Additional information on why the Phase was skipped, if available.
state This property is required. str
Current state of the Phase.
childRolloutJobs This property is required. Property Map
ChildRollout job composition.
deploymentJobs This property is required. Property Map
Deployment job composition.
skipMessage This property is required. String
Additional information on why the Phase was skipped, if available.
state This property is required. String
Current state of the Phase.

PostdeployJobResponse
, PostdeployJobResponseArgs

Actions This property is required. List<string>
The custom actions that the postdeploy Job executes.
Actions This property is required. []string
The custom actions that the postdeploy Job executes.
actions This property is required. List<String>
The custom actions that the postdeploy Job executes.
actions This property is required. string[]
The custom actions that the postdeploy Job executes.
actions This property is required. Sequence[str]
The custom actions that the postdeploy Job executes.
actions This property is required. List<String>
The custom actions that the postdeploy Job executes.

PredeployJobResponse
, PredeployJobResponseArgs

Actions This property is required. List<string>
The custom actions that the predeploy Job executes.
Actions This property is required. []string
The custom actions that the predeploy Job executes.
actions This property is required. List<String>
The custom actions that the predeploy Job executes.
actions This property is required. string[]
The custom actions that the predeploy Job executes.
actions This property is required. Sequence[str]
The custom actions that the predeploy Job executes.
actions This property is required. List<String>
The custom actions that the predeploy Job executes.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native