1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DevOps
  5. DeployPipeline
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.DevOps.DeployPipeline

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

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

    Creates a new deployment pipeline.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDeployPipeline = new oci.devops.DeployPipeline("test_deploy_pipeline", {
        projectId: testProject.id,
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        deployPipelineParameters: {
            items: [{
                name: deployPipelineDeployPipelineParametersItemsName,
                defaultValue: deployPipelineDeployPipelineParametersItemsDefaultValue,
                description: deployPipelineDeployPipelineParametersItemsDescription,
            }],
        },
        description: deployPipelineDescription,
        displayName: deployPipelineDisplayName,
        freeformTags: {
            "bar-key": "value",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_deploy_pipeline = oci.dev_ops.DeployPipeline("test_deploy_pipeline",
        project_id=test_project["id"],
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        deploy_pipeline_parameters=oci.dev_ops.DeployPipelineDeployPipelineParametersArgs(
            items=[oci.dev_ops.DeployPipelineDeployPipelineParametersItemArgs(
                name=deploy_pipeline_deploy_pipeline_parameters_items_name,
                default_value=deploy_pipeline_deploy_pipeline_parameters_items_default_value,
                description=deploy_pipeline_deploy_pipeline_parameters_items_description,
            )],
        ),
        description=deploy_pipeline_description,
        display_name=deploy_pipeline_display_name,
        freeform_tags={
            "bar-key": "value",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/DevOps"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DevOps.NewDeployPipeline(ctx, "test_deploy_pipeline", &DevOps.DeployPipelineArgs{
    			ProjectId: pulumi.Any(testProject.Id),
    			DefinedTags: pulumi.Map{
    				"foo-namespace.bar-key": pulumi.Any("value"),
    			},
    			DeployPipelineParameters: &devops.DeployPipelineDeployPipelineParametersArgs{
    				Items: devops.DeployPipelineDeployPipelineParametersItemArray{
    					&devops.DeployPipelineDeployPipelineParametersItemArgs{
    						Name:         pulumi.Any(deployPipelineDeployPipelineParametersItemsName),
    						DefaultValue: pulumi.Any(deployPipelineDeployPipelineParametersItemsDefaultValue),
    						Description:  pulumi.Any(deployPipelineDeployPipelineParametersItemsDescription),
    					},
    				},
    			},
    			Description: pulumi.Any(deployPipelineDescription),
    			DisplayName: pulumi.Any(deployPipelineDisplayName),
    			FreeformTags: pulumi.Map{
    				"bar-key": pulumi.Any("value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDeployPipeline = new Oci.DevOps.DeployPipeline("test_deploy_pipeline", new()
        {
            ProjectId = testProject.Id,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            DeployPipelineParameters = new Oci.DevOps.Inputs.DeployPipelineDeployPipelineParametersArgs
            {
                Items = new[]
                {
                    new Oci.DevOps.Inputs.DeployPipelineDeployPipelineParametersItemArgs
                    {
                        Name = deployPipelineDeployPipelineParametersItemsName,
                        DefaultValue = deployPipelineDeployPipelineParametersItemsDefaultValue,
                        Description = deployPipelineDeployPipelineParametersItemsDescription,
                    },
                },
            },
            Description = deployPipelineDescription,
            DisplayName = deployPipelineDisplayName,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DevOps.DeployPipeline;
    import com.pulumi.oci.DevOps.DeployPipelineArgs;
    import com.pulumi.oci.DevOps.inputs.DeployPipelineDeployPipelineParametersArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testDeployPipeline = new DeployPipeline("testDeployPipeline", DeployPipelineArgs.builder()
                .projectId(testProject.id())
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .deployPipelineParameters(DeployPipelineDeployPipelineParametersArgs.builder()
                    .items(DeployPipelineDeployPipelineParametersItemArgs.builder()
                        .name(deployPipelineDeployPipelineParametersItemsName)
                        .defaultValue(deployPipelineDeployPipelineParametersItemsDefaultValue)
                        .description(deployPipelineDeployPipelineParametersItemsDescription)
                        .build())
                    .build())
                .description(deployPipelineDescription)
                .displayName(deployPipelineDisplayName)
                .freeformTags(Map.of("bar-key", "value"))
                .build());
    
        }
    }
    
    resources:
      testDeployPipeline:
        type: oci:DevOps:DeployPipeline
        name: test_deploy_pipeline
        properties:
          projectId: ${testProject.id}
          definedTags:
            foo-namespace.bar-key: value
          deployPipelineParameters:
            items:
              - name: ${deployPipelineDeployPipelineParametersItemsName}
                defaultValue: ${deployPipelineDeployPipelineParametersItemsDefaultValue}
                description: ${deployPipelineDeployPipelineParametersItemsDescription}
          description: ${deployPipelineDescription}
          displayName: ${deployPipelineDisplayName}
          freeformTags:
            bar-key: value
    

    Create DeployPipeline Resource

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

    Constructor syntax

    new DeployPipeline(name: string, args: DeployPipelineArgs, opts?: CustomResourceOptions);
    @overload
    def DeployPipeline(resource_name: str,
                       args: DeployPipelineArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def DeployPipeline(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       project_id: Optional[str] = None,
                       defined_tags: Optional[Mapping[str, Any]] = None,
                       deploy_pipeline_parameters: Optional[_devops.DeployPipelineDeployPipelineParametersArgs] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewDeployPipeline(ctx *Context, name string, args DeployPipelineArgs, opts ...ResourceOption) (*DeployPipeline, error)
    public DeployPipeline(string name, DeployPipelineArgs args, CustomResourceOptions? opts = null)
    public DeployPipeline(String name, DeployPipelineArgs args)
    public DeployPipeline(String name, DeployPipelineArgs args, CustomResourceOptions options)
    
    type: oci:DevOps:DeployPipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var deployPipelineResource = new Oci.DevOps.DeployPipeline("deployPipelineResource", new()
    {
        ProjectId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        DeployPipelineParameters = new Oci.DevOps.Inputs.DeployPipelineDeployPipelineParametersArgs
        {
            Items = new[]
            {
                new Oci.DevOps.Inputs.DeployPipelineDeployPipelineParametersItemArgs
                {
                    Name = "string",
                    DefaultValue = "string",
                    Description = "string",
                },
            },
        },
        Description = "string",
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := DevOps.NewDeployPipeline(ctx, "deployPipelineResource", &DevOps.DeployPipelineArgs{
    	ProjectId: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DeployPipelineParameters: &devops.DeployPipelineDeployPipelineParametersArgs{
    		Items: devops.DeployPipelineDeployPipelineParametersItemArray{
    			&devops.DeployPipelineDeployPipelineParametersItemArgs{
    				Name:         pulumi.String("string"),
    				DefaultValue: pulumi.String("string"),
    				Description:  pulumi.String("string"),
    			},
    		},
    	},
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var deployPipelineResource = new DeployPipeline("deployPipelineResource", DeployPipelineArgs.builder()
        .projectId("string")
        .definedTags(Map.of("string", "any"))
        .deployPipelineParameters(DeployPipelineDeployPipelineParametersArgs.builder()
            .items(DeployPipelineDeployPipelineParametersItemArgs.builder()
                .name("string")
                .defaultValue("string")
                .description("string")
                .build())
            .build())
        .description("string")
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .build());
    
    deploy_pipeline_resource = oci.dev_ops.DeployPipeline("deployPipelineResource",
        project_id="string",
        defined_tags={
            "string": "any",
        },
        deploy_pipeline_parameters=oci.dev_ops.DeployPipelineDeployPipelineParametersArgs(
            items=[oci.dev_ops.DeployPipelineDeployPipelineParametersItemArgs(
                name="string",
                default_value="string",
                description="string",
            )],
        ),
        description="string",
        display_name="string",
        freeform_tags={
            "string": "any",
        })
    
    const deployPipelineResource = new oci.devops.DeployPipeline("deployPipelineResource", {
        projectId: "string",
        definedTags: {
            string: "any",
        },
        deployPipelineParameters: {
            items: [{
                name: "string",
                defaultValue: "string",
                description: "string",
            }],
        },
        description: "string",
        displayName: "string",
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:DevOps:DeployPipeline
    properties:
        definedTags:
            string: any
        deployPipelineParameters:
            items:
                - defaultValue: string
                  description: string
                  name: string
        description: string
        displayName: string
        freeformTags:
            string: any
        projectId: string
    

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

    ProjectId string

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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"}
    DeployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    Description string
    (Updatable) Optional description about the deployment pipeline.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    ProjectId string

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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"}
    DeployPipelineParameters DeployPipelineDeployPipelineParametersArgs
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    Description string
    (Updatable) Optional description about the deployment pipeline.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    projectId String

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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"}
    deployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description String
    (Updatable) Optional description about the deployment pipeline.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    projectId string

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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"}
    deployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description string
    (Updatable) Optional description about the deployment pipeline.
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    project_id str

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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_pipeline_parameters devops.DeployPipelineDeployPipelineParametersArgs
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description str
    (Updatable) Optional description about the deployment pipeline.
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    projectId String

    The OCID of a project.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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"}
    deployPipelineParameters Property Map
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description String
    (Updatable) Optional description about the deployment pipeline.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}

    Outputs

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

    CompartmentId string
    The OCID of the compartment where the pipeline is created.
    DeployPipelineArtifacts List<DeployPipelineDeployPipelineArtifact>
    List of all artifacts used in the pipeline.
    DeployPipelineEnvironments List<DeployPipelineDeployPipelineEnvironment>
    List of all environments used in the pipeline.
    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.
    State string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    CompartmentId string
    The OCID of the compartment where the pipeline is created.
    DeployPipelineArtifacts []DeployPipelineDeployPipelineArtifact
    List of all artifacts used in the pipeline.
    DeployPipelineEnvironments []DeployPipelineDeployPipelineEnvironment
    List of all environments used in the pipeline.
    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.
    State string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId String
    The OCID of the compartment where the pipeline is created.
    deployPipelineArtifacts List<DeployPipelineDeployPipelineArtifact>
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments List<DeployPipelineDeployPipelineEnvironment>
    List of all environments used in the pipeline.
    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.
    state String
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated String
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId string
    The OCID of the compartment where the pipeline is created.
    deployPipelineArtifacts DeployPipelineDeployPipelineArtifact[]
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments DeployPipelineDeployPipelineEnvironment[]
    List of all environments used in the pipeline.
    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.
    state string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartment_id str
    The OCID of the compartment where the pipeline is created.
    deploy_pipeline_artifacts Sequence[devops.DeployPipelineDeployPipelineArtifact]
    List of all artifacts used in the pipeline.
    deploy_pipeline_environments Sequence[devops.DeployPipelineDeployPipelineEnvironment]
    List of all environments used in the pipeline.
    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.
    state str
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    time_updated str
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId String
    The OCID of the compartment where the pipeline is created.
    deployPipelineArtifacts List<Property Map>
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments List<Property Map>
    List of all environments used in the pipeline.
    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.
    state String
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated String
    Time the deployment pipeline was updated. Format defined by RFC3339.

    Look up Existing DeployPipeline Resource

    Get an existing DeployPipeline 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?: DeployPipelineState, opts?: CustomResourceOptions): DeployPipeline
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            deploy_pipeline_artifacts: Optional[Sequence[_devops.DeployPipelineDeployPipelineArtifactArgs]] = None,
            deploy_pipeline_environments: Optional[Sequence[_devops.DeployPipelineDeployPipelineEnvironmentArgs]] = None,
            deploy_pipeline_parameters: Optional[_devops.DeployPipelineDeployPipelineParametersArgs] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_details: Optional[str] = None,
            project_id: Optional[str] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> DeployPipeline
    func GetDeployPipeline(ctx *Context, name string, id IDInput, state *DeployPipelineState, opts ...ResourceOption) (*DeployPipeline, error)
    public static DeployPipeline Get(string name, Input<string> id, DeployPipelineState? state, CustomResourceOptions? opts = null)
    public static DeployPipeline get(String name, Output<String> id, DeployPipelineState 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:
    CompartmentId string
    The OCID of the compartment where the pipeline is created.
    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"}
    DeployPipelineArtifacts List<DeployPipelineDeployPipelineArtifact>
    List of all artifacts used in the pipeline.
    DeployPipelineEnvironments List<DeployPipelineDeployPipelineEnvironment>
    List of all environments used in the pipeline.
    DeployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    Description string
    (Updatable) Optional description about the deployment pipeline.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    CompartmentId string
    The OCID of the compartment where the pipeline is created.
    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"}
    DeployPipelineArtifacts []DeployPipelineDeployPipelineArtifactArgs
    List of all artifacts used in the pipeline.
    DeployPipelineEnvironments []DeployPipelineDeployPipelineEnvironmentArgs
    List of all environments used in the pipeline.
    DeployPipelineParameters DeployPipelineDeployPipelineParametersArgs
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    Description string
    (Updatable) Optional description about the deployment pipeline.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId String
    The OCID of the compartment where the pipeline is created.
    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"}
    deployPipelineArtifacts List<DeployPipelineDeployPipelineArtifact>
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments List<DeployPipelineDeployPipelineEnvironment>
    List of all environments used in the pipeline.
    deployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description String
    (Updatable) Optional description about the deployment pipeline.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated String
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId string
    The OCID of the compartment where the pipeline is created.
    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"}
    deployPipelineArtifacts DeployPipelineDeployPipelineArtifact[]
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments DeployPipelineDeployPipelineEnvironment[]
    List of all environments used in the pipeline.
    deployPipelineParameters DeployPipelineDeployPipelineParameters
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description string
    (Updatable) Optional description about the deployment pipeline.
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state string
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated string
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartment_id str
    The OCID of the compartment where the pipeline is created.
    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_pipeline_artifacts Sequence[devops.DeployPipelineDeployPipelineArtifactArgs]
    List of all artifacts used in the pipeline.
    deploy_pipeline_environments Sequence[devops.DeployPipelineDeployPipelineEnvironmentArgs]
    List of all environments used in the pipeline.
    deploy_pipeline_parameters devops.DeployPipelineDeployPipelineParametersArgs
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description str
    (Updatable) Optional description about the deployment pipeline.
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state str
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    time_updated str
    Time the deployment pipeline was updated. Format defined by RFC3339.
    compartmentId String
    The OCID of the compartment where the pipeline is created.
    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"}
    deployPipelineArtifacts List<Property Map>
    List of all artifacts used in the pipeline.
    deployPipelineEnvironments List<Property Map>
    List of all environments used in the pipeline.
    deployPipelineParameters Property Map
    (Updatable) Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported.
    description String
    (Updatable) Optional description about the deployment pipeline.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    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"}
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current state of the deployment pipeline.
    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 pipeline was created. Format defined by RFC3339.
    timeUpdated String
    Time the deployment pipeline was updated. Format defined by RFC3339.

    Supporting Types

    DeployPipelineDeployPipelineArtifact, DeployPipelineDeployPipelineArtifactArgs

    Items List<DeployPipelineDeployPipelineArtifactItem>
    List of parameters defined for a deployment pipeline.
    Items []DeployPipelineDeployPipelineArtifactItem
    List of parameters defined for a deployment pipeline.
    items List<DeployPipelineDeployPipelineArtifactItem>
    List of parameters defined for a deployment pipeline.
    items DeployPipelineDeployPipelineArtifactItem[]
    List of parameters defined for a deployment pipeline.
    items Sequence[devops.DeployPipelineDeployPipelineArtifactItem]
    List of parameters defined for a deployment pipeline.
    items List<Property Map>
    List of parameters defined for a deployment pipeline.

    DeployPipelineDeployPipelineArtifactItem, DeployPipelineDeployPipelineArtifactItemArgs

    DeployArtifactId string
    The OCID of an artifact
    DeployPipelineStages List<DeployPipelineDeployPipelineArtifactItemDeployPipelineStage>
    List of stages.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    DeployArtifactId string
    The OCID of an artifact
    DeployPipelineStages []DeployPipelineDeployPipelineArtifactItemDeployPipelineStage
    List of stages.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployArtifactId String
    The OCID of an artifact
    deployPipelineStages List<DeployPipelineDeployPipelineArtifactItemDeployPipelineStage>
    List of stages.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployArtifactId string
    The OCID of an artifact
    deployPipelineStages DeployPipelineDeployPipelineArtifactItemDeployPipelineStage[]
    List of stages.
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deploy_artifact_id str
    The OCID of an artifact
    deploy_pipeline_stages Sequence[devops.DeployPipelineDeployPipelineArtifactItemDeployPipelineStage]
    List of stages.
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployArtifactId String
    The OCID of an artifact
    deployPipelineStages List<Property Map>
    List of stages.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.

    DeployPipelineDeployPipelineArtifactItemDeployPipelineStage, DeployPipelineDeployPipelineArtifactItemDeployPipelineStageArgs

    Items List<DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem>
    List of parameters defined for a deployment pipeline.
    Items []DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem
    List of parameters defined for a deployment pipeline.
    items List<DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem>
    List of parameters defined for a deployment pipeline.
    items DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem[]
    List of parameters defined for a deployment pipeline.
    items List<Property Map>
    List of parameters defined for a deployment pipeline.

    DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem, DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItemArgs

    DeployStageId string
    The OCID of a stage
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    DeployStageId string
    The OCID of a stage
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId String
    The OCID of a stage
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId string
    The OCID of a stage
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deploy_stage_id str
    The OCID of a stage
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId String
    The OCID of a stage
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.

    DeployPipelineDeployPipelineEnvironment, DeployPipelineDeployPipelineEnvironmentArgs

    Items List<DeployPipelineDeployPipelineEnvironmentItem>
    List of parameters defined for a deployment pipeline.
    Items []DeployPipelineDeployPipelineEnvironmentItem
    List of parameters defined for a deployment pipeline.
    items List<DeployPipelineDeployPipelineEnvironmentItem>
    List of parameters defined for a deployment pipeline.
    items DeployPipelineDeployPipelineEnvironmentItem[]
    List of parameters defined for a deployment pipeline.
    items Sequence[devops.DeployPipelineDeployPipelineEnvironmentItem]
    List of parameters defined for a deployment pipeline.
    items List<Property Map>
    List of parameters defined for a deployment pipeline.

    DeployPipelineDeployPipelineEnvironmentItem, DeployPipelineDeployPipelineEnvironmentItemArgs

    DeployEnvironmentId string
    The OCID of an Environment
    DeployPipelineStages List<DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage>
    List of stages.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    DeployEnvironmentId string
    The OCID of an Environment
    DeployPipelineStages []DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage
    List of stages.
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployEnvironmentId String
    The OCID of an Environment
    deployPipelineStages List<DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage>
    List of stages.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployEnvironmentId string
    The OCID of an Environment
    deployPipelineStages DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage[]
    List of stages.
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deploy_environment_id str
    The OCID of an Environment
    deploy_pipeline_stages Sequence[devops.DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage]
    List of stages.
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployEnvironmentId String
    The OCID of an Environment
    deployPipelineStages List<Property Map>
    List of stages.
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.

    DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage, DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageArgs

    Items List<DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem>
    List of parameters defined for a deployment pipeline.
    Items []DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem
    List of parameters defined for a deployment pipeline.
    items List<DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem>
    List of parameters defined for a deployment pipeline.
    items DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem[]
    List of parameters defined for a deployment pipeline.
    items List<Property Map>
    List of parameters defined for a deployment pipeline.

    DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem, DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItemArgs

    DeployStageId string
    The OCID of a stage
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    DeployStageId string
    The OCID of a stage
    DisplayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId String
    The OCID of a stage
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId string
    The OCID of a stage
    displayName string
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deploy_stage_id str
    The OCID of a stage
    display_name str
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.
    deployStageId String
    The OCID of a stage
    displayName String
    (Updatable) Deployment pipeline display name. Avoid entering confidential information.

    DeployPipelineDeployPipelineParameters, DeployPipelineDeployPipelineParametersArgs

    Items List<DeployPipelineDeployPipelineParametersItem>
    (Updatable) List of parameters defined for a deployment pipeline.
    Items []DeployPipelineDeployPipelineParametersItem
    (Updatable) List of parameters defined for a deployment pipeline.
    items List<DeployPipelineDeployPipelineParametersItem>
    (Updatable) List of parameters defined for a deployment pipeline.
    items DeployPipelineDeployPipelineParametersItem[]
    (Updatable) List of parameters defined for a deployment pipeline.
    items Sequence[devops.DeployPipelineDeployPipelineParametersItem]
    (Updatable) List of parameters defined for a deployment pipeline.
    items List<Property Map>
    (Updatable) List of parameters defined for a deployment pipeline.

    DeployPipelineDeployPipelineParametersItem, DeployPipelineDeployPipelineParametersItemArgs

    Name string
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    DefaultValue string
    (Updatable) Default value of the parameter.
    Description string
    (Updatable) Description of the parameter.
    Name string
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    DefaultValue string
    (Updatable) Default value of the parameter.
    Description string
    (Updatable) Description of the parameter.
    name String
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    defaultValue String
    (Updatable) Default value of the parameter.
    description String
    (Updatable) Description of the parameter.
    name string
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    defaultValue string
    (Updatable) Default value of the parameter.
    description string
    (Updatable) Description of the parameter.
    name str
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    default_value str
    (Updatable) Default value of the parameter.
    description str
    (Updatable) Description of the parameter.
    name String
    (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.
    defaultValue String
    (Updatable) Default value of the parameter.
    description String
    (Updatable) Description of the parameter.

    Import

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

    $ pulumi import oci:DevOps/deployPipeline:DeployPipeline test_deploy_pipeline "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi