oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DevOps.getDeployStage

This data source provides details about a specific Deploy Stage resource in Oracle Cloud Infrastructure Devops service.

Retrieves a deployment stage by identifier.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeployStage = Oci.DevOps.GetDeployStage.Invoke(new()
    {
        DeployStageId = oci_devops_deploy_stage.Test_deploy_stage.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DevOps"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DevOps.GetDeployStage(ctx, &devops.GetDeployStageArgs{
			DeployStageId: oci_devops_deploy_stage.Test_deploy_stage.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DevOps.DevOpsFunctions;
import com.pulumi.oci.DevOps.inputs.GetDeployStageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDeployStage = DevOpsFunctions.getDeployStage(GetDeployStageArgs.builder()
            .deployStageId(oci_devops_deploy_stage.test_deploy_stage().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_deploy_stage = oci.DevOps.get_deploy_stage(deploy_stage_id=oci_devops_deploy_stage["test_deploy_stage"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployStage = oci.DevOps.getDeployStage({
    deployStageId: oci_devops_deploy_stage.test_deploy_stage.id,
});
variables:
  testDeployStage:
    fn::invoke:
      Function: oci:DevOps:getDeployStage
      Arguments:
        deployStageId: ${oci_devops_deploy_stage.test_deploy_stage.id}

Using getDeployStage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeployStage(args: GetDeployStageArgs, opts?: InvokeOptions): Promise<GetDeployStageResult>
function getDeployStageOutput(args: GetDeployStageOutputArgs, opts?: InvokeOptions): Output<GetDeployStageResult>
def get_deploy_stage(deploy_stage_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDeployStageResult
def get_deploy_stage_output(deploy_stage_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDeployStageResult]
func GetDeployStage(ctx *Context, args *GetDeployStageArgs, opts ...InvokeOption) (*GetDeployStageResult, error)
func GetDeployStageOutput(ctx *Context, args *GetDeployStageOutputArgs, opts ...InvokeOption) GetDeployStageResultOutput

> Note: This function is named GetDeployStage in the Go SDK.

public static class GetDeployStage 
{
    public static Task<GetDeployStageResult> InvokeAsync(GetDeployStageArgs args, InvokeOptions? opts = null)
    public static Output<GetDeployStageResult> Invoke(GetDeployStageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeployStageResult> getDeployStage(GetDeployStageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:DevOps/getDeployStage:getDeployStage
  arguments:
    # arguments dictionary

The following arguments are supported:

DeployStageId string

Unique stage identifier.

DeployStageId string

Unique stage identifier.

deployStageId String

Unique stage identifier.

deployStageId string

Unique stage identifier.

deploy_stage_id str

Unique stage identifier.

deployStageId String

Unique stage identifier.

getDeployStage Result

The following output properties are available:

ApprovalPolicies List<GetDeployStageApprovalPolicy>

Specifies the approval policy.

AreHooksEnabled bool

Disable pre/post upgrade hooks. Set to false by default.

BlueBackendIps List<GetDeployStageBlueBackendIp>

Collection of backend environment IP addresses.

BlueGreenStrategies List<GetDeployStageBlueGreenStrategy>

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategies List<GetDeployStageCanaryStrategy>

Specifies the required canary release strategy for OKE deployment.

CommandSpecDeployArtifactId string

The OCID of the artifact that contains the command specification.

CompartmentId string

The OCID of the compartment where the ContainerInstance will be created.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

ComputeInstanceGroupCanaryDeployStageId string

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

A compute instance group canary traffic shift stage OCID for load balancer.

ComputeInstanceGroupDeployEnvironmentId string

A compute instance group environment OCID for rolling deployment.

Config Dictionary<string, object>

User provided key and value pair configuration, which is assigned through constants or parameter.

ContainerConfigs List<GetDeployStageContainerConfig>

Specifies the container configuration.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

DeployArtifactId string

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

DeployArtifactIds List<string>

The list of file artifact OCIDs to deploy.

DeployEnvironmentIdA string

First compute instance group environment OCID for deployment.

DeployEnvironmentIdB string

Second compute instance group environment OCID for deployment.

DeployPipelineId string

The OCID of a pipeline.

DeployStageId string
DeployStagePredecessorCollections List<GetDeployStageDeployStagePredecessorCollection>

Collection containing the predecessors of a stage.

DeployStageType string

Deployment stage type.

DeploymentSpecDeployArtifactId string

The OCID of the artifact that contains the deployment specification.

Description string

Optional description about the deployment stage.

DisplayName string

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

DockerImageDeployArtifactId string

A Docker image artifact OCID.

FailurePolicies List<GetDeployStageFailurePolicy>

Specifies a failure policy for a compute instance group rolling deployment stage.

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

FunctionDeployEnvironmentId string

Function environment OCID.

FunctionTimeoutInSeconds int

Timeout for execution of the Function. Value in seconds.

GreenBackendIps List<GetDeployStageGreenBackendIp>

Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

Helm chart artifact OCID.

Id string

Unique identifier that is immutable on creation.

IsAsync bool

A boolean flag specifies whether this stage executes asynchronously.

IsDebugEnabled bool

Enables helm --debug option to stream output to tf stdout. Set to false by default.

IsForceEnabled bool

Force resource update through delete; or if required, recreate. Set to false by default.

IsValidationEnabled bool

A boolean flag specifies whether the invoked function must be validated.

KubernetesManifestDeployArtifactIds List<string>

List of Kubernetes manifest artifact OCIDs.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

LoadBalancerConfigs List<GetDeployStageLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

MaxHistory int

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

MaxMemoryInMbs string

Maximum usable memory for the Function (in MB).

Namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

OkeBlueGreenDeployStageId string

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

OkeCanaryDeployStageId string

The OCID of an upstream OKE canary deployment stage in this pipeline.

OkeCanaryTrafficShiftDeployStageId string

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

OkeClusterDeployEnvironmentId string

Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfigs List<GetDeployStageProductionLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

ProjectId string

The OCID of a project.

ReleaseName string

Release name of the Helm chart.

RollbackPolicies List<GetDeployStageRollbackPolicy>

Specifies the rollback policy. This is initiated on the failure of certain stage types.

RolloutPolicies List<GetDeployStageRolloutPolicy>

Description of rollout policy for load balancer traffic shift stage.

SetStrings List<GetDeployStageSetString>

Specifies the name and value pairs to set helm values.

SetValues List<GetDeployStageSetValue>

Specifies the name and value pairs to set helm values.

ShouldCleanupOnFail bool

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

ShouldNotWait bool

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

ShouldResetValues bool

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

ShouldReuseValues bool

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

ShouldSkipCrds bool

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

ShouldSkipRenderSubchartNotes bool

If set, renders subchart notes along with the parent. Set to false by default.

State string

The current state of the deployment stage.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TestLoadBalancerConfigs List<GetDeployStageTestLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

TimeCreated string

Time the deployment stage was created. Format defined by RFC3339.

TimeUpdated string

Time the deployment stage was updated. Format defined by RFC3339.

TimeoutInSeconds int

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

TrafficShiftTarget string

Specifies the target or destination backend set.

ValuesArtifactIds List<string>

List of values.yaml file artifact OCIDs.

WaitCriterias List<GetDeployStageWaitCriteria>

Specifies wait criteria for the Wait stage.

ApprovalPolicies []GetDeployStageApprovalPolicy

Specifies the approval policy.

AreHooksEnabled bool

Disable pre/post upgrade hooks. Set to false by default.

BlueBackendIps []GetDeployStageBlueBackendIp

Collection of backend environment IP addresses.

BlueGreenStrategies []GetDeployStageBlueGreenStrategy

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategies []GetDeployStageCanaryStrategy

Specifies the required canary release strategy for OKE deployment.

CommandSpecDeployArtifactId string

The OCID of the artifact that contains the command specification.

CompartmentId string

The OCID of the compartment where the ContainerInstance will be created.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

ComputeInstanceGroupCanaryDeployStageId string

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

A compute instance group canary traffic shift stage OCID for load balancer.

ComputeInstanceGroupDeployEnvironmentId string

A compute instance group environment OCID for rolling deployment.

Config map[string]interface{}

User provided key and value pair configuration, which is assigned through constants or parameter.

ContainerConfigs []GetDeployStageContainerConfig

Specifies the container configuration.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

DeployArtifactId string

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

DeployArtifactIds []string

The list of file artifact OCIDs to deploy.

DeployEnvironmentIdA string

First compute instance group environment OCID for deployment.

DeployEnvironmentIdB string

Second compute instance group environment OCID for deployment.

DeployPipelineId string

The OCID of a pipeline.

DeployStageId string
DeployStagePredecessorCollections []GetDeployStageDeployStagePredecessorCollection

Collection containing the predecessors of a stage.

DeployStageType string

Deployment stage type.

DeploymentSpecDeployArtifactId string

The OCID of the artifact that contains the deployment specification.

Description string

Optional description about the deployment stage.

DisplayName string

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

DockerImageDeployArtifactId string

A Docker image artifact OCID.

FailurePolicies []GetDeployStageFailurePolicy

Specifies a failure policy for a compute instance group rolling deployment stage.

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

FunctionDeployEnvironmentId string

Function environment OCID.

FunctionTimeoutInSeconds int

Timeout for execution of the Function. Value in seconds.

GreenBackendIps []GetDeployStageGreenBackendIp

Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

Helm chart artifact OCID.

Id string

Unique identifier that is immutable on creation.

IsAsync bool

A boolean flag specifies whether this stage executes asynchronously.

IsDebugEnabled bool

Enables helm --debug option to stream output to tf stdout. Set to false by default.

IsForceEnabled bool

Force resource update through delete; or if required, recreate. Set to false by default.

IsValidationEnabled bool

A boolean flag specifies whether the invoked function must be validated.

KubernetesManifestDeployArtifactIds []string

List of Kubernetes manifest artifact OCIDs.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

LoadBalancerConfigs []GetDeployStageLoadBalancerConfig

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

MaxHistory int

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

MaxMemoryInMbs string

Maximum usable memory for the Function (in MB).

Namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

OkeBlueGreenDeployStageId string

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

OkeCanaryDeployStageId string

The OCID of an upstream OKE canary deployment stage in this pipeline.

OkeCanaryTrafficShiftDeployStageId string

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

OkeClusterDeployEnvironmentId string

Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfigs []GetDeployStageProductionLoadBalancerConfig

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

ProjectId string

The OCID of a project.

ReleaseName string

Release name of the Helm chart.

RollbackPolicies []GetDeployStageRollbackPolicy

Specifies the rollback policy. This is initiated on the failure of certain stage types.

RolloutPolicies []GetDeployStageRolloutPolicy

Description of rollout policy for load balancer traffic shift stage.

SetStrings []GetDeployStageSetString

Specifies the name and value pairs to set helm values.

SetValues []GetDeployStageSetValue

Specifies the name and value pairs to set helm values.

ShouldCleanupOnFail bool

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

ShouldNotWait bool

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

ShouldResetValues bool

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

ShouldReuseValues bool

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

ShouldSkipCrds bool

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

ShouldSkipRenderSubchartNotes bool

If set, renders subchart notes along with the parent. Set to false by default.

State string

The current state of the deployment stage.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TestLoadBalancerConfigs []GetDeployStageTestLoadBalancerConfig

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

TimeCreated string

Time the deployment stage was created. Format defined by RFC3339.

TimeUpdated string

Time the deployment stage was updated. Format defined by RFC3339.

TimeoutInSeconds int

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

TrafficShiftTarget string

Specifies the target or destination backend set.

ValuesArtifactIds []string

List of values.yaml file artifact OCIDs.

WaitCriterias []GetDeployStageWaitCriteria

Specifies wait criteria for the Wait stage.

approvalPolicies List<GetDeployStageApprovalPolicy>

Specifies the approval policy.

areHooksEnabled Boolean

Disable pre/post upgrade hooks. Set to false by default.

blueBackendIps List<GetDeployStageBlueBackendIp>

Collection of backend environment IP addresses.

blueGreenStrategies List<GetDeployStageBlueGreenStrategy>

Specifies the required blue green release strategy for OKE deployment.

canaryStrategies List<GetDeployStageCanaryStrategy>

Specifies the required canary release strategy for OKE deployment.

commandSpecDeployArtifactId String

The OCID of the artifact that contains the command specification.

compartmentId String

The OCID of the compartment where the ContainerInstance will be created.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

computeInstanceGroupCanaryDeployStageId String

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

A compute instance group canary traffic shift stage OCID for load balancer.

computeInstanceGroupDeployEnvironmentId String

A compute instance group environment OCID for rolling deployment.

config Map<String,Object>

User provided key and value pair configuration, which is assigned through constants or parameter.

containerConfigs List<GetDeployStageContainerConfig>

Specifies the container configuration.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

deployArtifactId String

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

deployArtifactIds List<String>

The list of file artifact OCIDs to deploy.

deployEnvironmentIdA String

First compute instance group environment OCID for deployment.

deployEnvironmentIdB String

Second compute instance group environment OCID for deployment.

deployPipelineId String

The OCID of a pipeline.

deployStageId String
deployStagePredecessorCollections List<GetDeployStageDeployStagePredecessorCollection>

Collection containing the predecessors of a stage.

deployStageType String

Deployment stage type.

deploymentSpecDeployArtifactId String

The OCID of the artifact that contains the deployment specification.

description String

Optional description about the deployment stage.

displayName String

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

dockerImageDeployArtifactId String

A Docker image artifact OCID.

failurePolicies List<GetDeployStageFailurePolicy>

Specifies a failure policy for a compute instance group rolling deployment stage.

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

functionDeployEnvironmentId String

Function environment OCID.

functionTimeoutInSeconds Integer

Timeout for execution of the Function. Value in seconds.

greenBackendIps List<GetDeployStageGreenBackendIp>

Collection of backend environment IP addresses.

helmChartDeployArtifactId String

Helm chart artifact OCID.

id String

Unique identifier that is immutable on creation.

isAsync Boolean

A boolean flag specifies whether this stage executes asynchronously.

isDebugEnabled Boolean

Enables helm --debug option to stream output to tf stdout. Set to false by default.

isForceEnabled Boolean

Force resource update through delete; or if required, recreate. Set to false by default.

isValidationEnabled Boolean

A boolean flag specifies whether the invoked function must be validated.

kubernetesManifestDeployArtifactIds List<String>

List of Kubernetes manifest artifact OCIDs.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

loadBalancerConfigs List<GetDeployStageLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

maxHistory Integer

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

maxMemoryInMbs String

Maximum usable memory for the Function (in MB).

namespace String

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

okeBlueGreenDeployStageId String

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

okeCanaryDeployStageId String

The OCID of an upstream OKE canary deployment stage in this pipeline.

okeCanaryTrafficShiftDeployStageId String

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

okeClusterDeployEnvironmentId String

Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfigs List<GetDeployStageProductionLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

projectId String

The OCID of a project.

releaseName String

Release name of the Helm chart.

rollbackPolicies List<GetDeployStageRollbackPolicy>

Specifies the rollback policy. This is initiated on the failure of certain stage types.

rolloutPolicies List<GetDeployStageRolloutPolicy>

Description of rollout policy for load balancer traffic shift stage.

setStrings List<GetDeployStageSetString>

Specifies the name and value pairs to set helm values.

setValues List<GetDeployStageSetValue>

Specifies the name and value pairs to set helm values.

shouldCleanupOnFail Boolean

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

shouldNotWait Boolean

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

shouldResetValues Boolean

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

shouldReuseValues Boolean

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

shouldSkipCrds Boolean

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

shouldSkipRenderSubchartNotes Boolean

If set, renders subchart notes along with the parent. Set to false by default.

state String

The current state of the deployment stage.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

testLoadBalancerConfigs List<GetDeployStageTestLoadBalancerConfig>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

timeCreated String

Time the deployment stage was created. Format defined by RFC3339.

timeUpdated String

Time the deployment stage was updated. Format defined by RFC3339.

timeoutInSeconds Integer

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

trafficShiftTarget String

Specifies the target or destination backend set.

valuesArtifactIds List<String>

List of values.yaml file artifact OCIDs.

waitCriterias List<GetDeployStageWaitCriteria>

Specifies wait criteria for the Wait stage.

approvalPolicies GetDeployStageApprovalPolicy[]

Specifies the approval policy.

areHooksEnabled boolean

Disable pre/post upgrade hooks. Set to false by default.

blueBackendIps GetDeployStageBlueBackendIp[]

Collection of backend environment IP addresses.

blueGreenStrategies GetDeployStageBlueGreenStrategy[]

Specifies the required blue green release strategy for OKE deployment.

canaryStrategies GetDeployStageCanaryStrategy[]

Specifies the required canary release strategy for OKE deployment.

commandSpecDeployArtifactId string

The OCID of the artifact that contains the command specification.

compartmentId string

The OCID of the compartment where the ContainerInstance will be created.

computeInstanceGroupBlueGreenDeploymentDeployStageId string

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

computeInstanceGroupCanaryDeployStageId string

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

computeInstanceGroupCanaryTrafficShiftDeployStageId string

A compute instance group canary traffic shift stage OCID for load balancer.

computeInstanceGroupDeployEnvironmentId string

A compute instance group environment OCID for rolling deployment.

config {[key: string]: any}

User provided key and value pair configuration, which is assigned through constants or parameter.

containerConfigs GetDeployStageContainerConfig[]

Specifies the container configuration.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

deployArtifactId string

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

deployArtifactIds string[]

The list of file artifact OCIDs to deploy.

deployEnvironmentIdA string

First compute instance group environment OCID for deployment.

deployEnvironmentIdB string

Second compute instance group environment OCID for deployment.

deployPipelineId string

The OCID of a pipeline.

deployStageId string
deployStagePredecessorCollections GetDeployStageDeployStagePredecessorCollection[]

Collection containing the predecessors of a stage.

deployStageType string

Deployment stage type.

deploymentSpecDeployArtifactId string

The OCID of the artifact that contains the deployment specification.

description string

Optional description about the deployment stage.

displayName string

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

dockerImageDeployArtifactId string

A Docker image artifact OCID.

failurePolicies GetDeployStageFailurePolicy[]

Specifies a failure policy for a compute instance group rolling deployment stage.

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

functionDeployEnvironmentId string

Function environment OCID.

functionTimeoutInSeconds number

Timeout for execution of the Function. Value in seconds.

greenBackendIps GetDeployStageGreenBackendIp[]

Collection of backend environment IP addresses.

helmChartDeployArtifactId string

Helm chart artifact OCID.

id string

Unique identifier that is immutable on creation.

isAsync boolean

A boolean flag specifies whether this stage executes asynchronously.

isDebugEnabled boolean

Enables helm --debug option to stream output to tf stdout. Set to false by default.

isForceEnabled boolean

Force resource update through delete; or if required, recreate. Set to false by default.

isValidationEnabled boolean

A boolean flag specifies whether the invoked function must be validated.

kubernetesManifestDeployArtifactIds string[]

List of Kubernetes manifest artifact OCIDs.

lifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

loadBalancerConfigs GetDeployStageLoadBalancerConfig[]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

maxHistory number

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

maxMemoryInMbs string

Maximum usable memory for the Function (in MB).

namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

okeBlueGreenDeployStageId string

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

okeCanaryDeployStageId string

The OCID of an upstream OKE canary deployment stage in this pipeline.

okeCanaryTrafficShiftDeployStageId string

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

okeClusterDeployEnvironmentId string

Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfigs GetDeployStageProductionLoadBalancerConfig[]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

projectId string

The OCID of a project.

releaseName string

Release name of the Helm chart.

rollbackPolicies GetDeployStageRollbackPolicy[]

Specifies the rollback policy. This is initiated on the failure of certain stage types.

rolloutPolicies GetDeployStageRolloutPolicy[]

Description of rollout policy for load balancer traffic shift stage.

setStrings GetDeployStageSetString[]

Specifies the name and value pairs to set helm values.

setValues GetDeployStageSetValue[]

Specifies the name and value pairs to set helm values.

shouldCleanupOnFail boolean

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

shouldNotWait boolean

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

shouldResetValues boolean

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

shouldReuseValues boolean

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

shouldSkipCrds boolean

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

shouldSkipRenderSubchartNotes boolean

If set, renders subchart notes along with the parent. Set to false by default.

state string

The current state of the deployment stage.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

testLoadBalancerConfigs GetDeployStageTestLoadBalancerConfig[]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

timeCreated string

Time the deployment stage was created. Format defined by RFC3339.

timeUpdated string

Time the deployment stage was updated. Format defined by RFC3339.

timeoutInSeconds number

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

trafficShiftTarget string

Specifies the target or destination backend set.

valuesArtifactIds string[]

List of values.yaml file artifact OCIDs.

waitCriterias GetDeployStageWaitCriteria[]

Specifies wait criteria for the Wait stage.

approval_policies GetDeployStageApprovalPolicy]

Specifies the approval policy.

are_hooks_enabled bool

Disable pre/post upgrade hooks. Set to false by default.

blue_backend_ips GetDeployStageBlueBackendIp]

Collection of backend environment IP addresses.

blue_green_strategies GetDeployStageBlueGreenStrategy]

Specifies the required blue green release strategy for OKE deployment.

canary_strategies GetDeployStageCanaryStrategy]

Specifies the required canary release strategy for OKE deployment.

command_spec_deploy_artifact_id str

The OCID of the artifact that contains the command specification.

compartment_id str

The OCID of the compartment where the ContainerInstance will be created.

compute_instance_group_blue_green_deployment_deploy_stage_id str

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

compute_instance_group_canary_deploy_stage_id str

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

compute_instance_group_canary_traffic_shift_deploy_stage_id str

A compute instance group canary traffic shift stage OCID for load balancer.

compute_instance_group_deploy_environment_id str

A compute instance group environment OCID for rolling deployment.

config Mapping[str, Any]

User provided key and value pair configuration, which is assigned through constants or parameter.

container_configs GetDeployStageContainerConfig]

Specifies the container configuration.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

deploy_artifact_id str

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

deploy_artifact_ids Sequence[str]

The list of file artifact OCIDs to deploy.

deploy_environment_id_a str

First compute instance group environment OCID for deployment.

deploy_environment_id_b str

Second compute instance group environment OCID for deployment.

deploy_pipeline_id str

The OCID of a pipeline.

deploy_stage_id str
deploy_stage_predecessor_collections GetDeployStageDeployStagePredecessorCollection]

Collection containing the predecessors of a stage.

deploy_stage_type str

Deployment stage type.

deployment_spec_deploy_artifact_id str

The OCID of the artifact that contains the deployment specification.

description str

Optional description about the deployment stage.

display_name str

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

docker_image_deploy_artifact_id str

A Docker image artifact OCID.

failure_policies GetDeployStageFailurePolicy]

Specifies a failure policy for a compute instance group rolling deployment stage.

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

function_deploy_environment_id str

Function environment OCID.

function_timeout_in_seconds int

Timeout for execution of the Function. Value in seconds.

green_backend_ips GetDeployStageGreenBackendIp]

Collection of backend environment IP addresses.

helm_chart_deploy_artifact_id str

Helm chart artifact OCID.

id str

Unique identifier that is immutable on creation.

is_async bool

A boolean flag specifies whether this stage executes asynchronously.

is_debug_enabled bool

Enables helm --debug option to stream output to tf stdout. Set to false by default.

is_force_enabled bool

Force resource update through delete; or if required, recreate. Set to false by default.

is_validation_enabled bool

A boolean flag specifies whether the invoked function must be validated.

kubernetes_manifest_deploy_artifact_ids Sequence[str]

List of Kubernetes manifest artifact OCIDs.

lifecycle_details str

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

load_balancer_configs GetDeployStageLoadBalancerConfig]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

max_history int

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

max_memory_in_mbs str

Maximum usable memory for the Function (in MB).

namespace str

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

oke_blue_green_deploy_stage_id str

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

oke_canary_deploy_stage_id str

The OCID of an upstream OKE canary deployment stage in this pipeline.

oke_canary_traffic_shift_deploy_stage_id str

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

oke_cluster_deploy_environment_id str

Kubernetes cluster environment OCID for deployment.

production_load_balancer_configs GetDeployStageProductionLoadBalancerConfig]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

project_id str

The OCID of a project.

release_name str

Release name of the Helm chart.

rollback_policies GetDeployStageRollbackPolicy]

Specifies the rollback policy. This is initiated on the failure of certain stage types.

rollout_policies GetDeployStageRolloutPolicy]

Description of rollout policy for load balancer traffic shift stage.

set_strings GetDeployStageSetString]

Specifies the name and value pairs to set helm values.

set_values GetDeployStageSetValue]

Specifies the name and value pairs to set helm values.

should_cleanup_on_fail bool

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

should_not_wait bool

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

should_reset_values bool

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

should_reuse_values bool

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

should_skip_crds bool

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

should_skip_render_subchart_notes bool

If set, renders subchart notes along with the parent. Set to false by default.

state str

The current state of the deployment stage.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

test_load_balancer_configs GetDeployStageTestLoadBalancerConfig]

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

time_created str

Time the deployment stage was created. Format defined by RFC3339.

time_updated str

Time the deployment stage was updated. Format defined by RFC3339.

timeout_in_seconds int

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

traffic_shift_target str

Specifies the target or destination backend set.

values_artifact_ids Sequence[str]

List of values.yaml file artifact OCIDs.

wait_criterias GetDeployStageWaitCriteria]

Specifies wait criteria for the Wait stage.

approvalPolicies List<Property Map>

Specifies the approval policy.

areHooksEnabled Boolean

Disable pre/post upgrade hooks. Set to false by default.

blueBackendIps List<Property Map>

Collection of backend environment IP addresses.

blueGreenStrategies List<Property Map>

Specifies the required blue green release strategy for OKE deployment.

canaryStrategies List<Property Map>

Specifies the required canary release strategy for OKE deployment.

commandSpecDeployArtifactId String

The OCID of the artifact that contains the command specification.

compartmentId String

The OCID of the compartment where the ContainerInstance will be created.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

computeInstanceGroupCanaryDeployStageId String

The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

A compute instance group canary traffic shift stage OCID for load balancer.

computeInstanceGroupDeployEnvironmentId String

A compute instance group environment OCID for rolling deployment.

config Map<Any>

User provided key and value pair configuration, which is assigned through constants or parameter.

containerConfigs List<Property Map>

Specifies the container configuration.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

deployArtifactId String

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

deployArtifactIds List<String>

The list of file artifact OCIDs to deploy.

deployEnvironmentIdA String

First compute instance group environment OCID for deployment.

deployEnvironmentIdB String

Second compute instance group environment OCID for deployment.

deployPipelineId String

The OCID of a pipeline.

deployStageId String
deployStagePredecessorCollections List<Property Map>

Collection containing the predecessors of a stage.

deployStageType String

Deployment stage type.

deploymentSpecDeployArtifactId String

The OCID of the artifact that contains the deployment specification.

description String

Optional description about the deployment stage.

displayName String

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

dockerImageDeployArtifactId String

A Docker image artifact OCID.

failurePolicies List<Property Map>

Specifies a failure policy for a compute instance group rolling deployment stage.

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

functionDeployEnvironmentId String

Function environment OCID.

functionTimeoutInSeconds Number

Timeout for execution of the Function. Value in seconds.

greenBackendIps List<Property Map>

Collection of backend environment IP addresses.

helmChartDeployArtifactId String

Helm chart artifact OCID.

id String

Unique identifier that is immutable on creation.

isAsync Boolean

A boolean flag specifies whether this stage executes asynchronously.

isDebugEnabled Boolean

Enables helm --debug option to stream output to tf stdout. Set to false by default.

isForceEnabled Boolean

Force resource update through delete; or if required, recreate. Set to false by default.

isValidationEnabled Boolean

A boolean flag specifies whether the invoked function must be validated.

kubernetesManifestDeployArtifactIds List<String>

List of Kubernetes manifest artifact OCIDs.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

loadBalancerConfigs List<Property Map>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

maxHistory Number

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

maxMemoryInMbs String

Maximum usable memory for the Function (in MB).

namespace String

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

okeBlueGreenDeployStageId String

The OCID of the upstream OKE blue-green deployment stage in this pipeline.

okeCanaryDeployStageId String

The OCID of an upstream OKE canary deployment stage in this pipeline.

okeCanaryTrafficShiftDeployStageId String

The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

okeClusterDeployEnvironmentId String

Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfigs List<Property Map>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

projectId String

The OCID of a project.

releaseName String

Release name of the Helm chart.

rollbackPolicies List<Property Map>

Specifies the rollback policy. This is initiated on the failure of certain stage types.

rolloutPolicies List<Property Map>

Description of rollout policy for load balancer traffic shift stage.

setStrings List<Property Map>

Specifies the name and value pairs to set helm values.

setValues List<Property Map>

Specifies the name and value pairs to set helm values.

shouldCleanupOnFail Boolean

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

shouldNotWait Boolean

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

shouldResetValues Boolean

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

shouldReuseValues Boolean

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

shouldSkipCrds Boolean

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

shouldSkipRenderSubchartNotes Boolean

If set, renders subchart notes along with the parent. Set to false by default.

state String

The current state of the deployment stage.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

testLoadBalancerConfigs List<Property Map>

Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported.

timeCreated String

Time the deployment stage was created. Format defined by RFC3339.

timeUpdated String

Time the deployment stage was updated. Format defined by RFC3339.

timeoutInSeconds Number

Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage

trafficShiftTarget String

Specifies the target or destination backend set.

valuesArtifactIds List<String>

List of values.yaml file artifact OCIDs.

waitCriterias List<Property Map>

Specifies wait criteria for the Wait stage.

Supporting Types

GetDeployStageApprovalPolicy

ApprovalPolicyType string

Approval policy type.

NumberOfApprovalsRequired int

A minimum number of approvals required for stage to proceed.

ApprovalPolicyType string

Approval policy type.

NumberOfApprovalsRequired int

A minimum number of approvals required for stage to proceed.

approvalPolicyType String

Approval policy type.

numberOfApprovalsRequired Integer

A minimum number of approvals required for stage to proceed.

approvalPolicyType string

Approval policy type.

numberOfApprovalsRequired number

A minimum number of approvals required for stage to proceed.

approval_policy_type str

Approval policy type.

number_of_approvals_required int

A minimum number of approvals required for stage to proceed.

approvalPolicyType String

Approval policy type.

numberOfApprovalsRequired Number

A minimum number of approvals required for stage to proceed.

GetDeployStageBlueBackendIp

Items List<string>

List of parameters defined to set helm value.

Items []string

List of parameters defined to set helm value.

items List<String>

List of parameters defined to set helm value.

items string[]

List of parameters defined to set helm value.

items Sequence[str]

List of parameters defined to set helm value.

items List<String>

List of parameters defined to set helm value.

GetDeployStageBlueGreenStrategy

IngressName string

Name of the Ingress resource.

NamespaceA string

First Namespace for deployment.

NamespaceB string

Second Namespace for deployment.

StrategyType string

Canary strategy type.

IngressName string

Name of the Ingress resource.

NamespaceA string

First Namespace for deployment.

NamespaceB string

Second Namespace for deployment.

StrategyType string

Canary strategy type.

ingressName String

Name of the Ingress resource.

namespaceA String

First Namespace for deployment.

namespaceB String

Second Namespace for deployment.

strategyType String

Canary strategy type.

ingressName string

Name of the Ingress resource.

namespaceA string

First Namespace for deployment.

namespaceB string

Second Namespace for deployment.

strategyType string

Canary strategy type.

ingress_name str

Name of the Ingress resource.

namespace_a str

First Namespace for deployment.

namespace_b str

Second Namespace for deployment.

strategy_type str

Canary strategy type.

ingressName String

Name of the Ingress resource.

namespaceA String

First Namespace for deployment.

namespaceB String

Second Namespace for deployment.

strategyType String

Canary strategy type.

GetDeployStageCanaryStrategy

IngressName string

Name of the Ingress resource.

Namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

StrategyType string

Canary strategy type.

IngressName string

Name of the Ingress resource.

Namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

StrategyType string

Canary strategy type.

ingressName String

Name of the Ingress resource.

namespace String

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

strategyType String

Canary strategy type.

ingressName string

Name of the Ingress resource.

namespace string

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

strategyType string

Canary strategy type.

ingress_name str

Name of the Ingress resource.

namespace str

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

strategy_type str

Canary strategy type.

ingressName String

Name of the Ingress resource.

namespace String

Default Namespace to be used for Kubernetes deployment when not specified in the manifest.

strategyType String

Canary strategy type.

GetDeployStageContainerConfig

AvailabilityDomain string

Availability domain where the ContainerInstance will be created.

CompartmentId string

The OCID of the compartment where the ContainerInstance will be created.

ContainerConfigType string

Container configuration type.

NetworkChannels List<GetDeployStageContainerConfigNetworkChannel>

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

ShapeConfigs List<GetDeployStageContainerConfigShapeConfig>

Determines the size and amount of resources available to the instance.

ShapeName string

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

AvailabilityDomain string

Availability domain where the ContainerInstance will be created.

CompartmentId string

The OCID of the compartment where the ContainerInstance will be created.

ContainerConfigType string

Container configuration type.

NetworkChannels []GetDeployStageContainerConfigNetworkChannel

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

ShapeConfigs []GetDeployStageContainerConfigShapeConfig

Determines the size and amount of resources available to the instance.

ShapeName string

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

availabilityDomain String

Availability domain where the ContainerInstance will be created.

compartmentId String

The OCID of the compartment where the ContainerInstance will be created.

containerConfigType String

Container configuration type.

networkChannels List<GetDeployStageContainerConfigNetworkChannel>

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

shapeConfigs List<GetDeployStageContainerConfigShapeConfig>

Determines the size and amount of resources available to the instance.

shapeName String

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

availabilityDomain string

Availability domain where the ContainerInstance will be created.

compartmentId string

The OCID of the compartment where the ContainerInstance will be created.

containerConfigType string

Container configuration type.

networkChannels GetDeployStageContainerConfigNetworkChannel[]

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

shapeConfigs GetDeployStageContainerConfigShapeConfig[]

Determines the size and amount of resources available to the instance.

shapeName string

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

availability_domain str

Availability domain where the ContainerInstance will be created.

compartment_id str

The OCID of the compartment where the ContainerInstance will be created.

container_config_type str

Container configuration type.

network_channels GetDeployStageContainerConfigNetworkChannel]

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

shape_configs GetDeployStageContainerConfigShapeConfig]

Determines the size and amount of resources available to the instance.

shape_name str

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

availabilityDomain String

Availability domain where the ContainerInstance will be created.

compartmentId String

The OCID of the compartment where the ContainerInstance will be created.

containerConfigType String

Container configuration type.

networkChannels List<Property Map>

Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

shapeConfigs List<Property Map>

Determines the size and amount of resources available to the instance.

shapeName String

The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

GetDeployStageContainerConfigNetworkChannel

NetworkChannelType string

Network channel type.

NsgIds List<string>

An array of network security group OCIDs.

SubnetId string

The OCID of the subnet where VNIC resources will be created for private endpoint.

NetworkChannelType string

Network channel type.

NsgIds []string

An array of network security group OCIDs.

SubnetId string

The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType String

Network channel type.

nsgIds List<String>

An array of network security group OCIDs.

subnetId String

The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType string

Network channel type.

nsgIds string[]

An array of network security group OCIDs.

subnetId string

The OCID of the subnet where VNIC resources will be created for private endpoint.

network_channel_type str

Network channel type.

nsg_ids Sequence[str]

An array of network security group OCIDs.

subnet_id str

The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType String

Network channel type.

nsgIds List<String>

An array of network security group OCIDs.

subnetId String

The OCID of the subnet where VNIC resources will be created for private endpoint.

GetDeployStageContainerConfigShapeConfig

MemoryInGbs double

The total amount of memory available to the instance, in gigabytes.

Ocpus double

The total number of OCPUs available to the instance.

MemoryInGbs float64

The total amount of memory available to the instance, in gigabytes.

Ocpus float64

The total number of OCPUs available to the instance.

memoryInGbs Double

The total amount of memory available to the instance, in gigabytes.

ocpus Double

The total number of OCPUs available to the instance.

memoryInGbs number

The total amount of memory available to the instance, in gigabytes.

ocpus number

The total number of OCPUs available to the instance.

memory_in_gbs float

The total amount of memory available to the instance, in gigabytes.

ocpus float

The total number of OCPUs available to the instance.

memoryInGbs Number

The total amount of memory available to the instance, in gigabytes.

ocpus Number

The total number of OCPUs available to the instance.

GetDeployStageDeployStagePredecessorCollection

Items List<GetDeployStageDeployStagePredecessorCollectionItem>

List of parameters defined to set helm value.

Items []GetDeployStageDeployStagePredecessorCollectionItem

List of parameters defined to set helm value.

items List<GetDeployStageDeployStagePredecessorCollectionItem>

List of parameters defined to set helm value.

items GetDeployStageDeployStagePredecessorCollectionItem[]

List of parameters defined to set helm value.

items GetDeployStageDeployStagePredecessorCollectionItem]

List of parameters defined to set helm value.

items List<Property Map>

List of parameters defined to set helm value.

GetDeployStageDeployStagePredecessorCollectionItem

Id string

Unique identifier that is immutable on creation.

Id string

Unique identifier that is immutable on creation.

id String

Unique identifier that is immutable on creation.

id string

Unique identifier that is immutable on creation.

id str

Unique identifier that is immutable on creation.

id String

Unique identifier that is immutable on creation.

GetDeployStageFailurePolicy

FailureCount int

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

FailurePercentage int

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

PolicyType string

The type of policy used for rolling out a deployment stage.

FailureCount int

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

FailurePercentage int

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

PolicyType string

The type of policy used for rolling out a deployment stage.

failureCount Integer

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

failurePercentage Integer

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

policyType String

The type of policy used for rolling out a deployment stage.

failureCount number

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

failurePercentage number

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

policyType string

The type of policy used for rolling out a deployment stage.

failure_count int

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

failure_percentage int

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

policy_type str

The type of policy used for rolling out a deployment stage.

failureCount Number

The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED.

failurePercentage Number

The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

policyType String

The type of policy used for rolling out a deployment stage.

GetDeployStageGreenBackendIp

Items List<string>

List of parameters defined to set helm value.

Items []string

List of parameters defined to set helm value.

items List<String>

List of parameters defined to set helm value.

items string[]

List of parameters defined to set helm value.

items Sequence[str]

List of parameters defined to set helm value.

items List<String>

List of parameters defined to set helm value.

GetDeployStageLoadBalancerConfig

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

Listen port for the backend server.

listenerName string

Name of the load balancer listener.

loadBalancerId string

The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

Listen port for the backend server.

listener_name str

Name of the load balancer listener.

load_balancer_id str

The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

GetDeployStageProductionLoadBalancerConfig

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

Listen port for the backend server.

listenerName string

Name of the load balancer listener.

loadBalancerId string

The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

Listen port for the backend server.

listener_name str

Name of the load balancer listener.

load_balancer_id str

The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

GetDeployStageRollbackPolicy

PolicyType string

The type of policy used for rolling out a deployment stage.

PolicyType string

The type of policy used for rolling out a deployment stage.

policyType String

The type of policy used for rolling out a deployment stage.

policyType string

The type of policy used for rolling out a deployment stage.

policy_type str

The type of policy used for rolling out a deployment stage.

policyType String

The type of policy used for rolling out a deployment stage.

GetDeployStageRolloutPolicy

BatchCount int

The number that will be used to determine how many instances will be deployed concurrently.

BatchDelayInSeconds int

The duration of delay between batch rollout. The default delay is 1 minute.

BatchPercentage int

The percentage that will be used to determine how many instances will be deployed concurrently.

PolicyType string

The type of policy used for rolling out a deployment stage.

RampLimitPercent double

Indicates the criteria to stop.

BatchCount int

The number that will be used to determine how many instances will be deployed concurrently.

BatchDelayInSeconds int

The duration of delay between batch rollout. The default delay is 1 minute.

BatchPercentage int

The percentage that will be used to determine how many instances will be deployed concurrently.

PolicyType string

The type of policy used for rolling out a deployment stage.

RampLimitPercent float64

Indicates the criteria to stop.

batchCount Integer

The number that will be used to determine how many instances will be deployed concurrently.

batchDelayInSeconds Integer

The duration of delay between batch rollout. The default delay is 1 minute.

batchPercentage Integer

The percentage that will be used to determine how many instances will be deployed concurrently.

policyType String

The type of policy used for rolling out a deployment stage.

rampLimitPercent Double

Indicates the criteria to stop.

batchCount number

The number that will be used to determine how many instances will be deployed concurrently.

batchDelayInSeconds number

The duration of delay between batch rollout. The default delay is 1 minute.

batchPercentage number

The percentage that will be used to determine how many instances will be deployed concurrently.

policyType string

The type of policy used for rolling out a deployment stage.

rampLimitPercent number

Indicates the criteria to stop.

batch_count int

The number that will be used to determine how many instances will be deployed concurrently.

batch_delay_in_seconds int

The duration of delay between batch rollout. The default delay is 1 minute.

batch_percentage int

The percentage that will be used to determine how many instances will be deployed concurrently.

policy_type str

The type of policy used for rolling out a deployment stage.

ramp_limit_percent float

Indicates the criteria to stop.

batchCount Number

The number that will be used to determine how many instances will be deployed concurrently.

batchDelayInSeconds Number

The duration of delay between batch rollout. The default delay is 1 minute.

batchPercentage Number

The percentage that will be used to determine how many instances will be deployed concurrently.

policyType String

The type of policy used for rolling out a deployment stage.

rampLimitPercent Number

Indicates the criteria to stop.

GetDeployStageSetString

Items List<GetDeployStageSetStringItem>

List of parameters defined to set helm value.

Items []GetDeployStageSetStringItem

List of parameters defined to set helm value.

items List<GetDeployStageSetStringItem>

List of parameters defined to set helm value.

items GetDeployStageSetStringItem[]

List of parameters defined to set helm value.

items GetDeployStageSetStringItem]

List of parameters defined to set helm value.

items List<Property Map>

List of parameters defined to set helm value.

GetDeployStageSetStringItem

Name string

Name of the parameter (case-sensitive).

Value string

Value of the parameter.

Name string

Name of the parameter (case-sensitive).

Value string

Value of the parameter.

name String

Name of the parameter (case-sensitive).

value String

Value of the parameter.

name string

Name of the parameter (case-sensitive).

value string

Value of the parameter.

name str

Name of the parameter (case-sensitive).

value str

Value of the parameter.

name String

Name of the parameter (case-sensitive).

value String

Value of the parameter.

GetDeployStageSetValue

Items List<GetDeployStageSetValueItem>

List of parameters defined to set helm value.

Items []GetDeployStageSetValueItem

List of parameters defined to set helm value.

items List<GetDeployStageSetValueItem>

List of parameters defined to set helm value.

items GetDeployStageSetValueItem[]

List of parameters defined to set helm value.

items GetDeployStageSetValueItem]

List of parameters defined to set helm value.

items List<Property Map>

List of parameters defined to set helm value.

GetDeployStageSetValueItem

Name string

Name of the parameter (case-sensitive).

Value string

Value of the parameter.

Name string

Name of the parameter (case-sensitive).

Value string

Value of the parameter.

name String

Name of the parameter (case-sensitive).

value String

Value of the parameter.

name string

Name of the parameter (case-sensitive).

value string

Value of the parameter.

name str

Name of the parameter (case-sensitive).

value str

Value of the parameter.

name String

Name of the parameter (case-sensitive).

value String

Value of the parameter.

GetDeployStageTestLoadBalancerConfig

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

Listen port for the backend server.

ListenerName string

Name of the load balancer listener.

LoadBalancerId string

The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

Listen port for the backend server.

listenerName string

Name of the load balancer listener.

loadBalancerId string

The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

Listen port for the backend server.

listener_name str

Name of the load balancer listener.

load_balancer_id str

The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

Listen port for the backend server.

listenerName String

Name of the load balancer listener.

loadBalancerId String

The OCID of the load balancer.

state String

The current state of the deployment stage.

GetDeployStageWaitCriteria

WaitDuration string

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

WaitType string

Wait criteria type.

WaitDuration string

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

WaitType string

Wait criteria type.

waitDuration String

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

waitType String

Wait criteria type.

waitDuration string

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

waitType string

Wait criteria type.

wait_duration str

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

wait_type str

Wait criteria type.

waitDuration String

The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

waitType String

Wait criteria type.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.