Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

DeployStage

This resource provides the Deploy Stage resource in Oracle Cloud Infrastructure Devops service.

Creates a new deployment stage.

Create DeployStage Resource

new DeployStage(name: string, args: DeployStageArgs, opts?: CustomResourceOptions);
@overload
def DeployStage(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                approval_policy: Optional[_devops.DeployStageApprovalPolicyArgs] = None,
                blue_backend_ips: Optional[_devops.DeployStageBlueBackendIpsArgs] = None,
                blue_green_strategy: Optional[_devops.DeployStageBlueGreenStrategyArgs] = None,
                canary_strategy: Optional[_devops.DeployStageCanaryStrategyArgs] = None,
                compute_instance_group_blue_green_deployment_deploy_stage_id: Optional[str] = None,
                compute_instance_group_canary_deploy_stage_id: Optional[str] = None,
                compute_instance_group_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
                compute_instance_group_deploy_environment_id: Optional[str] = None,
                config: Optional[Mapping[str, Any]] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                deploy_artifact_id: Optional[str] = None,
                deploy_artifact_ids: Optional[Sequence[str]] = None,
                deploy_environment_id_a: Optional[str] = None,
                deploy_environment_id_b: Optional[str] = None,
                deploy_pipeline_id: Optional[str] = None,
                deploy_stage_predecessor_collection: Optional[_devops.DeployStageDeployStagePredecessorCollectionArgs] = None,
                deploy_stage_type: Optional[str] = None,
                deployment_spec_deploy_artifact_id: Optional[str] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                docker_image_deploy_artifact_id: Optional[str] = None,
                failure_policy: Optional[_devops.DeployStageFailurePolicyArgs] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None,
                function_deploy_environment_id: Optional[str] = None,
                function_timeout_in_seconds: Optional[int] = None,
                green_backend_ips: Optional[_devops.DeployStageGreenBackendIpsArgs] = None,
                helm_chart_deploy_artifact_id: Optional[str] = None,
                is_async: Optional[bool] = None,
                is_validation_enabled: Optional[bool] = None,
                kubernetes_manifest_deploy_artifact_ids: Optional[Sequence[str]] = None,
                load_balancer_config: Optional[_devops.DeployStageLoadBalancerConfigArgs] = None,
                max_memory_in_mbs: Optional[str] = None,
                namespace: Optional[str] = None,
                oke_blue_green_deploy_stage_id: Optional[str] = None,
                oke_canary_deploy_stage_id: Optional[str] = None,
                oke_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
                oke_cluster_deploy_environment_id: Optional[str] = None,
                production_load_balancer_config: Optional[_devops.DeployStageProductionLoadBalancerConfigArgs] = None,
                release_name: Optional[str] = None,
                rollback_policy: Optional[_devops.DeployStageRollbackPolicyArgs] = None,
                rollout_policy: Optional[_devops.DeployStageRolloutPolicyArgs] = None,
                test_load_balancer_config: Optional[_devops.DeployStageTestLoadBalancerConfigArgs] = None,
                timeout_in_seconds: Optional[int] = None,
                traffic_shift_target: Optional[str] = None,
                values_artifact_ids: Optional[Sequence[str]] = None,
                wait_criteria: Optional[_devops.DeployStageWaitCriteriaArgs] = None)
@overload
def DeployStage(resource_name: str,
                args: DeployStageArgs,
                opts: Optional[ResourceOptions] = None)
func NewDeployStage(ctx *Context, name string, args DeployStageArgs, opts ...ResourceOption) (*DeployStage, error)
public DeployStage(string name, DeployStageArgs args, CustomResourceOptions? opts = null)
public DeployStage(String name, DeployStageArgs args)
public DeployStage(String name, DeployStageArgs args, CustomResourceOptions options)
type: oci:DevOps:DeployStage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DeployStageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DeployStageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DeployStageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeployStageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeployStageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DeployStage Resource Properties

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

Inputs

The DeployStage resource accepts the following input properties:

DeployPipelineId string

The OCID of a pipeline.

DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

DeployStageType string

(Updatable) Deployment stage type.

ApprovalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

BlueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

BlueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

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

ComputeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

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

ComputeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

Config Dictionary<string, object>

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

DefinedTags Dictionary<string, object>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

DeploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

Description string

(Updatable) Optional description about the deployment stage.

DisplayName string

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

DockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

FailurePolicy DeployStageFailurePolicyArgs

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

FreeformTags Dictionary<string, object>

(Updatable) 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

(Updatable) Function environment OCID.

FunctionTimeoutInSeconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

GreenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

IsAsync bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

IsValidationEnabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

KubernetesManifestDeployArtifactIds List<string>

(Updatable) List of Kubernetes manifest artifact OCIDs.

LoadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

MaxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

Namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

ReleaseName string

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

RollbackPolicy DeployStageRollbackPolicyArgs

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

RolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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.

TimeoutInSeconds int

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

TrafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

ValuesArtifactIds List<string>

(Updatable) List of values.yaml file artifact OCIDs.

WaitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

DeployPipelineId string

The OCID of a pipeline.

DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

DeployStageType string

(Updatable) Deployment stage type.

ApprovalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

BlueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

BlueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

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

ComputeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

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

ComputeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

Config map[string]interface{}

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

DefinedTags map[string]interface{}

(Updatable) 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

(Updatable) 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

(Updatable) 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.

DeploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

Description string

(Updatable) Optional description about the deployment stage.

DisplayName string

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

DockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

FailurePolicy DeployStageFailurePolicyArgs

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

FreeformTags map[string]interface{}

(Updatable) 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

(Updatable) Function environment OCID.

FunctionTimeoutInSeconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

GreenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

IsAsync bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

IsValidationEnabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

KubernetesManifestDeployArtifactIds []string

(Updatable) List of Kubernetes manifest artifact OCIDs.

LoadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

MaxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

Namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

ReleaseName string

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

RollbackPolicy DeployStageRollbackPolicyArgs

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

RolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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.

TimeoutInSeconds int

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

TrafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

ValuesArtifactIds []string

(Updatable) List of values.yaml file artifact OCIDs.

WaitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

deployPipelineId String

The OCID of a pipeline.

deployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deployStageType String

(Updatable) Deployment stage type.

approvalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

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

computeInstanceGroupCanaryDeployStageId String

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

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

computeInstanceGroupDeployEnvironmentId String

(Updatable) A compute instance group environment OCID for rolling deployment.

config Map<String,Object>

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

definedTags Map<String,Object>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

deploymentSpecDeployArtifactId String

(Updatable) The OCID of the artifact that contains the deployment specification.

description String

(Updatable) Optional description about the deployment stage.

displayName String

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

dockerImageDeployArtifactId String

(Updatable) A Docker image artifact OCID.

failurePolicy DeployStageFailurePolicyArgs

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

freeformTags Map<String,Object>

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds Integer

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId String

(Updatable) Helm chart artifact OCID.

isAsync Boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled Boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds List<String>

(Updatable) List of Kubernetes manifest artifact OCIDs.

loadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

maxMemoryInMbs String

(Updatable) Maximum usable memory for the Function (in MB).

namespace String

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

releaseName String

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy DeployStageRollbackPolicyArgs

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

rolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

testLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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.

timeoutInSeconds Integer

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget String

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds List<String>

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

deployPipelineId string

The OCID of a pipeline.

deployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deployStageType string

(Updatable) Deployment stage type.

approvalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

computeInstanceGroupBlueGreenDeploymentDeployStageId string

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

computeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId string

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

computeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

config {[key: string]: any}

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

definedTags {[key: string]: any}

(Updatable) 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

(Updatable) 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[]

(Updatable) 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.

deploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

description string

(Updatable) Optional description about the deployment stage.

displayName string

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

dockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

failurePolicy DeployStageFailurePolicyArgs

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

freeformTags {[key: string]: any}

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds number

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

isAsync boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds string[]

(Updatable) List of Kubernetes manifest artifact OCIDs.

loadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

maxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

releaseName string

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy DeployStageRollbackPolicyArgs

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

rolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

testLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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.

timeoutInSeconds number

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds string[]

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

deploy_pipeline_id str

The OCID of a pipeline.

deploy_stage_predecessor_collection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deploy_stage_type str

(Updatable) Deployment stage type.

approval_policy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blue_backend_ips DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blue_green_strategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canary_strategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

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

A compute instance group canary stage OCID for load balancer.

compute_instance_group_canary_traffic_shift_deploy_stage_id str

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

compute_instance_group_deploy_environment_id str

(Updatable) A compute instance group environment OCID for rolling deployment.

config Mapping[str, Any]

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

defined_tags Mapping[str, Any]

(Updatable) 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

(Updatable) 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]

(Updatable) 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.

deployment_spec_deploy_artifact_id str

(Updatable) The OCID of the artifact that contains the deployment specification.

description str

(Updatable) Optional description about the deployment stage.

display_name str

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

docker_image_deploy_artifact_id str

(Updatable) A Docker image artifact OCID.

failure_policy DeployStageFailurePolicyArgs

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

freeform_tags Mapping[str, Any]

(Updatable) 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

(Updatable) Function environment OCID.

function_timeout_in_seconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

green_backend_ips DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helm_chart_deploy_artifact_id str

(Updatable) Helm chart artifact OCID.

is_async bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

is_validation_enabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetes_manifest_deploy_artifact_ids Sequence[str]

(Updatable) List of Kubernetes manifest artifact OCIDs.

load_balancer_config DeployStageLoadBalancerConfigArgs

(Updatable) 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_memory_in_mbs str

(Updatable) Maximum usable memory for the Function (in MB).

namespace str

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

production_load_balancer_config DeployStageProductionLoadBalancerConfigArgs

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

release_name str

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollback_policy DeployStageRollbackPolicyArgs

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

rollout_policy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

test_load_balancer_config DeployStageTestLoadBalancerConfigArgs

(Updatable) 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.

timeout_in_seconds int

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

traffic_shift_target str

(Updatable) Specifies the target or destination backend set.

values_artifact_ids Sequence[str]

(Updatable) List of values.yaml file artifact OCIDs.

wait_criteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

deployPipelineId String

The OCID of a pipeline.

deployStagePredecessorCollection Property Map

(Updatable) Collection containing the predecessors of a stage.

deployStageType String

(Updatable) Deployment stage type.

approvalPolicy Property Map

(Updatable) Specifies the approval policy.

blueBackendIps Property Map

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy Property Map

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy Property Map

Specifies the required canary release strategy for OKE deployment.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

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

computeInstanceGroupCanaryDeployStageId String

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

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

computeInstanceGroupDeployEnvironmentId String

(Updatable) A compute instance group environment OCID for rolling deployment.

config Map<Any>

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

definedTags Map<Any>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

deploymentSpecDeployArtifactId String

(Updatable) The OCID of the artifact that contains the deployment specification.

description String

(Updatable) Optional description about the deployment stage.

displayName String

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

dockerImageDeployArtifactId String

(Updatable) A Docker image artifact OCID.

failurePolicy Property Map

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

freeformTags Map<Any>

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds Number

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps Property Map

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId String

(Updatable) Helm chart artifact OCID.

isAsync Boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled Boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds List<String>

(Updatable) List of Kubernetes manifest artifact OCIDs.

loadBalancerConfig Property Map

(Updatable) 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.

maxMemoryInMbs String

(Updatable) Maximum usable memory for the Function (in MB).

namespace String

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig Property Map

Specifies configuration for load balancer traffic shift stages. The load balancer specified here should be an Application load balancer type. Network load balancers are not supported.

releaseName String

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy Property Map

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

rolloutPolicy Property Map

(Updatable) Description of rollout policy for load balancer traffic shift stage.

testLoadBalancerConfig Property Map

(Updatable) 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.

timeoutInSeconds Number

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget String

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds List<String>

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria Property Map

(Updatable) Specifies wait criteria for the Wait stage.

Outputs

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

CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

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.

ProjectId string

The OCID of a project.

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"}

TimeCreated string

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

TimeUpdated string

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

CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

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.

ProjectId string

The OCID of a project.

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"}

TimeCreated string

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

TimeUpdated string

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

compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

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.

projectId String

The OCID of a project.

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"}

timeCreated String

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

timeUpdated String

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

compartmentId string

The OCID of a compartment.

id string

The provider-assigned unique ID for this managed resource.

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.

projectId string

The OCID of a project.

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"}

timeCreated string

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

timeUpdated string

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

compartment_id str

The OCID of a compartment.

id str

The provider-assigned unique ID for this managed resource.

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.

project_id str

The OCID of a project.

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"}

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.

compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

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.

projectId String

The OCID of a project.

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"}

timeCreated String

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

timeUpdated String

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

Look up Existing DeployStage Resource

Get an existing DeployStage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeployStageState, opts?: CustomResourceOptions): DeployStage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        approval_policy: Optional[_devops.DeployStageApprovalPolicyArgs] = None,
        blue_backend_ips: Optional[_devops.DeployStageBlueBackendIpsArgs] = None,
        blue_green_strategy: Optional[_devops.DeployStageBlueGreenStrategyArgs] = None,
        canary_strategy: Optional[_devops.DeployStageCanaryStrategyArgs] = None,
        compartment_id: Optional[str] = None,
        compute_instance_group_blue_green_deployment_deploy_stage_id: Optional[str] = None,
        compute_instance_group_canary_deploy_stage_id: Optional[str] = None,
        compute_instance_group_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
        compute_instance_group_deploy_environment_id: Optional[str] = None,
        config: Optional[Mapping[str, Any]] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        deploy_artifact_id: Optional[str] = None,
        deploy_artifact_ids: Optional[Sequence[str]] = None,
        deploy_environment_id_a: Optional[str] = None,
        deploy_environment_id_b: Optional[str] = None,
        deploy_pipeline_id: Optional[str] = None,
        deploy_stage_predecessor_collection: Optional[_devops.DeployStageDeployStagePredecessorCollectionArgs] = None,
        deploy_stage_type: Optional[str] = None,
        deployment_spec_deploy_artifact_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        docker_image_deploy_artifact_id: Optional[str] = None,
        failure_policy: Optional[_devops.DeployStageFailurePolicyArgs] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        function_deploy_environment_id: Optional[str] = None,
        function_timeout_in_seconds: Optional[int] = None,
        green_backend_ips: Optional[_devops.DeployStageGreenBackendIpsArgs] = None,
        helm_chart_deploy_artifact_id: Optional[str] = None,
        is_async: Optional[bool] = None,
        is_validation_enabled: Optional[bool] = None,
        kubernetes_manifest_deploy_artifact_ids: Optional[Sequence[str]] = None,
        lifecycle_details: Optional[str] = None,
        load_balancer_config: Optional[_devops.DeployStageLoadBalancerConfigArgs] = None,
        max_memory_in_mbs: Optional[str] = None,
        namespace: Optional[str] = None,
        oke_blue_green_deploy_stage_id: Optional[str] = None,
        oke_canary_deploy_stage_id: Optional[str] = None,
        oke_canary_traffic_shift_deploy_stage_id: Optional[str] = None,
        oke_cluster_deploy_environment_id: Optional[str] = None,
        production_load_balancer_config: Optional[_devops.DeployStageProductionLoadBalancerConfigArgs] = None,
        project_id: Optional[str] = None,
        release_name: Optional[str] = None,
        rollback_policy: Optional[_devops.DeployStageRollbackPolicyArgs] = None,
        rollout_policy: Optional[_devops.DeployStageRolloutPolicyArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        test_load_balancer_config: Optional[_devops.DeployStageTestLoadBalancerConfigArgs] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        traffic_shift_target: Optional[str] = None,
        values_artifact_ids: Optional[Sequence[str]] = None,
        wait_criteria: Optional[_devops.DeployStageWaitCriteriaArgs] = None) -> DeployStage
func GetDeployStage(ctx *Context, name string, id IDInput, state *DeployStageState, opts ...ResourceOption) (*DeployStage, error)
public static DeployStage Get(string name, Input<string> id, DeployStageState? state, CustomResourceOptions? opts = null)
public static DeployStage get(String name, Output<String> id, DeployStageState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApprovalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

BlueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

BlueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

CompartmentId string

The OCID of a compartment.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

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

ComputeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

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

ComputeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

Config Dictionary<string, object>

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

DefinedTags Dictionary<string, object>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

DeployStageType string

(Updatable) Deployment stage type.

DeploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

Description string

(Updatable) Optional description about the deployment stage.

DisplayName string

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

DockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

FailurePolicy DeployStageFailurePolicyArgs

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

FreeformTags Dictionary<string, object>

(Updatable) 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

(Updatable) Function environment OCID.

FunctionTimeoutInSeconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

GreenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

IsAsync bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

IsValidationEnabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

KubernetesManifestDeployArtifactIds List<string>

(Updatable) 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.

LoadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

MaxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

Namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

RollbackPolicy DeployStageRollbackPolicyArgs

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

RolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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"}

TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

TrafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

ValuesArtifactIds List<string>

(Updatable) List of values.yaml file artifact OCIDs.

WaitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

ApprovalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

BlueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

BlueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

CanaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

CompartmentId string

The OCID of a compartment.

ComputeInstanceGroupBlueGreenDeploymentDeployStageId string

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

ComputeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

ComputeInstanceGroupCanaryTrafficShiftDeployStageId string

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

ComputeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

Config map[string]interface{}

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

DefinedTags map[string]interface{}

(Updatable) 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

(Updatable) 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

(Updatable) 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.

DeployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

DeployStageType string

(Updatable) Deployment stage type.

DeploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

Description string

(Updatable) Optional description about the deployment stage.

DisplayName string

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

DockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

FailurePolicy DeployStageFailurePolicyArgs

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

FreeformTags map[string]interface{}

(Updatable) 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

(Updatable) Function environment OCID.

FunctionTimeoutInSeconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

GreenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

HelmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

IsAsync bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

IsValidationEnabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

KubernetesManifestDeployArtifactIds []string

(Updatable) 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.

LoadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

MaxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

Namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

ProductionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

RollbackPolicy DeployStageRollbackPolicyArgs

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

RolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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"}

TestLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

TrafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

ValuesArtifactIds []string

(Updatable) List of values.yaml file artifact OCIDs.

WaitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

approvalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

compartmentId String

The OCID of a compartment.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

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

computeInstanceGroupCanaryDeployStageId String

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

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

computeInstanceGroupDeployEnvironmentId String

(Updatable) A compute instance group environment OCID for rolling deployment.

config Map<String,Object>

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

definedTags Map<String,Object>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

deployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deployStageType String

(Updatable) Deployment stage type.

deploymentSpecDeployArtifactId String

(Updatable) The OCID of the artifact that contains the deployment specification.

description String

(Updatable) Optional description about the deployment stage.

displayName String

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

dockerImageDeployArtifactId String

(Updatable) A Docker image artifact OCID.

failurePolicy DeployStageFailurePolicyArgs

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

freeformTags Map<String,Object>

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds Integer

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId String

(Updatable) Helm chart artifact OCID.

isAsync Boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled Boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds List<String>

(Updatable) 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.

loadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

maxMemoryInMbs String

(Updatable) Maximum usable memory for the Function (in MB).

namespace String

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy DeployStageRollbackPolicyArgs

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

rolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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"}

testLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget String

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds List<String>

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

approvalPolicy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blueBackendIps DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

compartmentId string

The OCID of a compartment.

computeInstanceGroupBlueGreenDeploymentDeployStageId string

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

computeInstanceGroupCanaryDeployStageId string

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId string

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

computeInstanceGroupDeployEnvironmentId string

(Updatable) A compute instance group environment OCID for rolling deployment.

config {[key: string]: any}

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

definedTags {[key: string]: any}

(Updatable) 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

(Updatable) 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[]

(Updatable) 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.

deployStagePredecessorCollection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deployStageType string

(Updatable) Deployment stage type.

deploymentSpecDeployArtifactId string

(Updatable) The OCID of the artifact that contains the deployment specification.

description string

(Updatable) Optional description about the deployment stage.

displayName string

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

dockerImageDeployArtifactId string

(Updatable) A Docker image artifact OCID.

failurePolicy DeployStageFailurePolicyArgs

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

freeformTags {[key: string]: any}

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds number

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId string

(Updatable) Helm chart artifact OCID.

isAsync boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds string[]

(Updatable) 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.

loadBalancerConfig DeployStageLoadBalancerConfigArgs

(Updatable) 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.

maxMemoryInMbs string

(Updatable) Maximum usable memory for the Function (in MB).

namespace string

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig DeployStageProductionLoadBalancerConfigArgs

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy DeployStageRollbackPolicyArgs

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

rolloutPolicy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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"}

testLoadBalancerConfig DeployStageTestLoadBalancerConfigArgs

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget string

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds string[]

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

approval_policy DeployStageApprovalPolicyArgs

(Updatable) Specifies the approval policy.

blue_backend_ips DeployStageBlueBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

blue_green_strategy DeployStageBlueGreenStrategyArgs

Specifies the required blue green release strategy for OKE deployment.

canary_strategy DeployStageCanaryStrategyArgs

Specifies the required canary release strategy for OKE deployment.

compartment_id str

The OCID of a compartment.

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

A compute instance group canary stage OCID for load balancer.

compute_instance_group_canary_traffic_shift_deploy_stage_id str

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

compute_instance_group_deploy_environment_id str

(Updatable) A compute instance group environment OCID for rolling deployment.

config Mapping[str, Any]

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

defined_tags Mapping[str, Any]

(Updatable) 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

(Updatable) 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]

(Updatable) 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_predecessor_collection DeployStageDeployStagePredecessorCollectionArgs

(Updatable) Collection containing the predecessors of a stage.

deploy_stage_type str

(Updatable) Deployment stage type.

deployment_spec_deploy_artifact_id str

(Updatable) The OCID of the artifact that contains the deployment specification.

description str

(Updatable) Optional description about the deployment stage.

display_name str

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

docker_image_deploy_artifact_id str

(Updatable) A Docker image artifact OCID.

failure_policy DeployStageFailurePolicyArgs

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

freeform_tags Mapping[str, Any]

(Updatable) 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

(Updatable) Function environment OCID.

function_timeout_in_seconds int

(Updatable) Timeout for execution of the Function. Value in seconds.

green_backend_ips DeployStageGreenBackendIpsArgs

(Updatable) Collection of backend environment IP addresses.

helm_chart_deploy_artifact_id str

(Updatable) Helm chart artifact OCID.

is_async bool

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

is_validation_enabled bool

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetes_manifest_deploy_artifact_ids Sequence[str]

(Updatable) 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_config DeployStageLoadBalancerConfigArgs

(Updatable) 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_memory_in_mbs str

(Updatable) Maximum usable memory for the Function (in MB).

namespace str

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

production_load_balancer_config DeployStageProductionLoadBalancerConfigArgs

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollback_policy DeployStageRollbackPolicyArgs

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

rollout_policy DeployStageRolloutPolicyArgs

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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_config DeployStageTestLoadBalancerConfigArgs

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

traffic_shift_target str

(Updatable) Specifies the target or destination backend set.

values_artifact_ids Sequence[str]

(Updatable) List of values.yaml file artifact OCIDs.

wait_criteria DeployStageWaitCriteriaArgs

(Updatable) Specifies wait criteria for the Wait stage.

approvalPolicy Property Map

(Updatable) Specifies the approval policy.

blueBackendIps Property Map

(Updatable) Collection of backend environment IP addresses.

blueGreenStrategy Property Map

Specifies the required blue green release strategy for OKE deployment.

canaryStrategy Property Map

Specifies the required canary release strategy for OKE deployment.

compartmentId String

The OCID of a compartment.

computeInstanceGroupBlueGreenDeploymentDeployStageId String

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

computeInstanceGroupCanaryDeployStageId String

A compute instance group canary stage OCID for load balancer.

computeInstanceGroupCanaryTrafficShiftDeployStageId String

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

computeInstanceGroupDeployEnvironmentId String

(Updatable) A compute instance group environment OCID for rolling deployment.

config Map<Any>

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

definedTags Map<Any>

(Updatable) 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

(Updatable) 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>

(Updatable) 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.

deployStagePredecessorCollection Property Map

(Updatable) Collection containing the predecessors of a stage.

deployStageType String

(Updatable) Deployment stage type.

deploymentSpecDeployArtifactId String

(Updatable) The OCID of the artifact that contains the deployment specification.

description String

(Updatable) Optional description about the deployment stage.

displayName String

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

dockerImageDeployArtifactId String

(Updatable) A Docker image artifact OCID.

failurePolicy Property Map

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

freeformTags Map<Any>

(Updatable) 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

(Updatable) Function environment OCID.

functionTimeoutInSeconds Number

(Updatable) Timeout for execution of the Function. Value in seconds.

greenBackendIps Property Map

(Updatable) Collection of backend environment IP addresses.

helmChartDeployArtifactId String

(Updatable) Helm chart artifact OCID.

isAsync Boolean

(Updatable) A boolean flag specifies whether this stage executes asynchronously.

isValidationEnabled Boolean

(Updatable) A boolean flag specifies whether the invoked function should be validated.

kubernetesManifestDeployArtifactIds List<String>

(Updatable) 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.

loadBalancerConfig Property Map

(Updatable) 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.

maxMemoryInMbs String

(Updatable) Maximum usable memory for the Function (in MB).

namespace String

(Updatable) 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

(Updatable) Kubernetes cluster environment OCID for deployment.

productionLoadBalancerConfig Property Map

Specifies configuration 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

(Updatable) Default name of the chart instance. Must be unique within a Kubernetes namespace.

rollbackPolicy Property Map

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

rolloutPolicy Property Map

(Updatable) Description of rollout policy for load balancer traffic shift stage.

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"}

testLoadBalancerConfig Property Map

(Updatable) 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

(Updatable) Time to wait for execution of a helm stage. Defaults to 300 seconds.

trafficShiftTarget String

(Updatable) Specifies the target or destination backend set.

valuesArtifactIds List<String>

(Updatable) List of values.yaml file artifact OCIDs.

waitCriteria Property Map

(Updatable) Specifies wait criteria for the Wait stage.

Supporting Types

DeployStageApprovalPolicy

ApprovalPolicyType string

(Updatable) Approval policy type.

NumberOfApprovalsRequired int

(Updatable) A minimum number of approvals required for stage to proceed.

ApprovalPolicyType string

(Updatable) Approval policy type.

NumberOfApprovalsRequired int

(Updatable) A minimum number of approvals required for stage to proceed.

approvalPolicyType String

(Updatable) Approval policy type.

numberOfApprovalsRequired Integer

(Updatable) A minimum number of approvals required for stage to proceed.

approvalPolicyType string

(Updatable) Approval policy type.

numberOfApprovalsRequired number

(Updatable) A minimum number of approvals required for stage to proceed.

approval_policy_type str

(Updatable) Approval policy type.

number_of_approvals_required int

(Updatable) A minimum number of approvals required for stage to proceed.

approvalPolicyType String

(Updatable) Approval policy type.

numberOfApprovalsRequired Number

(Updatable) A minimum number of approvals required for stage to proceed.

DeployStageBlueBackendIps

Items List<string>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

Items []string

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<String>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items string[]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items Sequence[str]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<String>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

DeployStageBlueGreenStrategy

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

DeployStageCanaryStrategy

IngressName string

Name of the Ingress resource.

Namespace string

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) Default namespace to be used for Kubernetes deployment when not specified in the manifest.

strategyType String

Canary strategy type

DeployStageDeployStagePredecessorCollection

Items List<DeployStageDeployStagePredecessorCollectionItem>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

Items []DeployStageDeployStagePredecessorCollectionItem

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<DeployStageDeployStagePredecessorCollectionItem>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items DeployStageDeployStagePredecessorCollectionItem[]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items DeployStageDeployStagePredecessorCollectionItem]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<Property Map>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

DeployStageDeployStagePredecessorCollectionItem

Id string

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

Id string

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

id String

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

id string

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

id str

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

id String

(Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

DeployStageFailurePolicy

PolicyType string

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

FailureCount int

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

FailurePercentage int

(Updatable) 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

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

FailureCount int

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

FailurePercentage int

(Updatable) 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

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

failureCount Integer

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

failurePercentage Integer

(Updatable) 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

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

failureCount number

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

failurePercentage number

(Updatable) 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

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

failure_count int

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

failure_percentage int

(Updatable) 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

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

failureCount Number

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

failurePercentage Number

(Updatable) 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.

DeployStageGreenBackendIps

Items List<string>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

Items []string

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<String>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items string[]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items Sequence[str]

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

items List<String>

(Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer.

DeployStageLoadBalancerConfig

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

(Updatable) Listen port for the backend server.

listenerName string

(Updatable) Name of the load balancer listener.

loadBalancerId string

(Updatable) The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

(Updatable) Listen port for the backend server.

listener_name str

(Updatable) Name of the load balancer listener.

load_balancer_id str

(Updatable) The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

DeployStageProductionLoadBalancerConfig

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

(Updatable) Listen port for the backend server.

listenerName string

(Updatable) Name of the load balancer listener.

loadBalancerId string

(Updatable) The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

(Updatable) Listen port for the backend server.

listener_name str

(Updatable) Name of the load balancer listener.

load_balancer_id str

(Updatable) The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

DeployStageRollbackPolicy

PolicyType string

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

PolicyType string

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

policyType String

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

policyType string

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

policy_type str

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

policyType String

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

DeployStageRolloutPolicy

BatchCount int

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

BatchDelayInSeconds int

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

BatchPercentage int

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

PolicyType string

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

RampLimitPercent double

(Updatable) Indicates the criteria to stop.

BatchCount int

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

BatchDelayInSeconds int

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

BatchPercentage int

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

PolicyType string

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

RampLimitPercent float64

(Updatable) Indicates the criteria to stop.

batchCount Integer

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

batchDelayInSeconds Integer

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

batchPercentage Integer

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

policyType String

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

rampLimitPercent Double

(Updatable) Indicates the criteria to stop.

batchCount number

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

batchDelayInSeconds number

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

batchPercentage number

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

policyType string

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

rampLimitPercent number

(Updatable) Indicates the criteria to stop.

batch_count int

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

batch_delay_in_seconds int

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

batch_percentage int

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

policy_type str

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

ramp_limit_percent float

(Updatable) Indicates the criteria to stop.

batchCount Number

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

batchDelayInSeconds Number

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

batchPercentage Number

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

policyType String

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

rampLimitPercent Number

(Updatable) Indicates the criteria to stop.

DeployStageTestLoadBalancerConfig

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

BackendPort int

(Updatable) Listen port for the backend server.

ListenerName string

(Updatable) Name of the load balancer listener.

LoadBalancerId string

(Updatable) The OCID of the load balancer.

State string

The current state of the deployment stage.

backendPort Integer

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

backendPort number

(Updatable) Listen port for the backend server.

listenerName string

(Updatable) Name of the load balancer listener.

loadBalancerId string

(Updatable) The OCID of the load balancer.

state string

The current state of the deployment stage.

backend_port int

(Updatable) Listen port for the backend server.

listener_name str

(Updatable) Name of the load balancer listener.

load_balancer_id str

(Updatable) The OCID of the load balancer.

state str

The current state of the deployment stage.

backendPort Number

(Updatable) Listen port for the backend server.

listenerName String

(Updatable) Name of the load balancer listener.

loadBalancerId String

(Updatable) The OCID of the load balancer.

state String

The current state of the deployment stage.

DeployStageWaitCriteria

WaitDuration string

(Updatable) 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

(Updatable) Wait criteria type.

WaitDuration string

(Updatable) 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

(Updatable) Wait criteria type.

waitDuration String

(Updatable) 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

(Updatable) Wait criteria type.

waitDuration string

(Updatable) 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

(Updatable) Wait criteria type.

wait_duration str

(Updatable) 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

(Updatable) Wait criteria type.

waitDuration String

(Updatable) 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

(Updatable) Wait criteria type.

Import

DeployStages can be imported using the id, e.g.

 $ pulumi import oci:DevOps/deployStage:DeployStage test_deploy_stage "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.