1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. DeploymentFreezeProject
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploy.DeploymentFreezeProject

Explore with Pulumi AI

Create DeploymentFreezeProject Resource

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

Constructor syntax

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

@overload
def DeploymentFreezeProject(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            deploymentfreeze_id: Optional[str] = None,
                            project_id: Optional[str] = None,
                            environment_ids: Optional[Sequence[str]] = None)
func NewDeploymentFreezeProject(ctx *Context, name string, args DeploymentFreezeProjectArgs, opts ...ResourceOption) (*DeploymentFreezeProject, error)
public DeploymentFreezeProject(string name, DeploymentFreezeProjectArgs args, CustomResourceOptions? opts = null)
public DeploymentFreezeProject(String name, DeploymentFreezeProjectArgs args)
public DeploymentFreezeProject(String name, DeploymentFreezeProjectArgs args, CustomResourceOptions options)
type: octopusdeploy:DeploymentFreezeProject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var deploymentFreezeProjectResource = new Octopusdeploy.DeploymentFreezeProject("deploymentFreezeProjectResource", new()
{
    DeploymentfreezeId = "string",
    ProjectId = "string",
    EnvironmentIds = new[]
    {
        "string",
    },
});
Copy
example, err := octopusdeploy.NewDeploymentFreezeProject(ctx, "deploymentFreezeProjectResource", &octopusdeploy.DeploymentFreezeProjectArgs{
	DeploymentfreezeId: pulumi.String("string"),
	ProjectId:          pulumi.String("string"),
	EnvironmentIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var deploymentFreezeProjectResource = new DeploymentFreezeProject("deploymentFreezeProjectResource", DeploymentFreezeProjectArgs.builder()
    .deploymentfreezeId("string")
    .projectId("string")
    .environmentIds("string")
    .build());
Copy
deployment_freeze_project_resource = octopusdeploy.DeploymentFreezeProject("deploymentFreezeProjectResource",
    deploymentfreeze_id="string",
    project_id="string",
    environment_ids=["string"])
Copy
const deploymentFreezeProjectResource = new octopusdeploy.DeploymentFreezeProject("deploymentFreezeProjectResource", {
    deploymentfreezeId: "string",
    projectId: "string",
    environmentIds: ["string"],
});
Copy
type: octopusdeploy:DeploymentFreezeProject
properties:
    deploymentfreezeId: string
    environmentIds:
        - string
    projectId: string
Copy

DeploymentFreezeProject Resource Properties

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

Inputs

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

The DeploymentFreezeProject resource accepts the following input properties:

DeploymentfreezeId This property is required. string
The deployment freeze ID associated with this freeze scope.
ProjectId This property is required. string
The project ID associated with this freeze scope.
EnvironmentIds List<string>
The environment IDs associated with this project deployment freeze scope.
DeploymentfreezeId This property is required. string
The deployment freeze ID associated with this freeze scope.
ProjectId This property is required. string
The project ID associated with this freeze scope.
EnvironmentIds []string
The environment IDs associated with this project deployment freeze scope.
deploymentfreezeId This property is required. String
The deployment freeze ID associated with this freeze scope.
projectId This property is required. String
The project ID associated with this freeze scope.
environmentIds List<String>
The environment IDs associated with this project deployment freeze scope.
deploymentfreezeId This property is required. string
The deployment freeze ID associated with this freeze scope.
projectId This property is required. string
The project ID associated with this freeze scope.
environmentIds string[]
The environment IDs associated with this project deployment freeze scope.
deploymentfreeze_id This property is required. str
The deployment freeze ID associated with this freeze scope.
project_id This property is required. str
The project ID associated with this freeze scope.
environment_ids Sequence[str]
The environment IDs associated with this project deployment freeze scope.
deploymentfreezeId This property is required. String
The deployment freeze ID associated with this freeze scope.
projectId This property is required. String
The project ID associated with this freeze scope.
environmentIds List<String>
The environment IDs associated with this project deployment freeze scope.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing DeploymentFreezeProject Resource

Get an existing DeploymentFreezeProject 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?: DeploymentFreezeProjectState, opts?: CustomResourceOptions): DeploymentFreezeProject
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deploymentfreeze_id: Optional[str] = None,
        environment_ids: Optional[Sequence[str]] = None,
        project_id: Optional[str] = None) -> DeploymentFreezeProject
func GetDeploymentFreezeProject(ctx *Context, name string, id IDInput, state *DeploymentFreezeProjectState, opts ...ResourceOption) (*DeploymentFreezeProject, error)
public static DeploymentFreezeProject Get(string name, Input<string> id, DeploymentFreezeProjectState? state, CustomResourceOptions? opts = null)
public static DeploymentFreezeProject get(String name, Output<String> id, DeploymentFreezeProjectState state, CustomResourceOptions options)
resources:  _:    type: octopusdeploy:DeploymentFreezeProject    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DeploymentfreezeId string
The deployment freeze ID associated with this freeze scope.
EnvironmentIds List<string>
The environment IDs associated with this project deployment freeze scope.
ProjectId string
The project ID associated with this freeze scope.
DeploymentfreezeId string
The deployment freeze ID associated with this freeze scope.
EnvironmentIds []string
The environment IDs associated with this project deployment freeze scope.
ProjectId string
The project ID associated with this freeze scope.
deploymentfreezeId String
The deployment freeze ID associated with this freeze scope.
environmentIds List<String>
The environment IDs associated with this project deployment freeze scope.
projectId String
The project ID associated with this freeze scope.
deploymentfreezeId string
The deployment freeze ID associated with this freeze scope.
environmentIds string[]
The environment IDs associated with this project deployment freeze scope.
projectId string
The project ID associated with this freeze scope.
deploymentfreeze_id str
The deployment freeze ID associated with this freeze scope.
environment_ids Sequence[str]
The environment IDs associated with this project deployment freeze scope.
project_id str
The project ID associated with this freeze scope.
deploymentfreezeId String
The deployment freeze ID associated with this freeze scope.
environmentIds List<String>
The environment IDs associated with this project deployment freeze scope.
projectId String
The project ID associated with this freeze scope.

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.