1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. StepTemplate
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.StepTemplate

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    This resource manages step_templates in Octopus Deploy.

    Create StepTemplate Resource

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

    Constructor syntax

    new StepTemplate(name: string, args: StepTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def StepTemplate(resource_name: str,
                     args: StepTemplateArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def StepTemplate(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action_type: Optional[str] = None,
                     packages: Optional[Sequence[StepTemplatePackageArgs]] = None,
                     parameters: Optional[Sequence[StepTemplateParameterArgs]] = None,
                     properties: Optional[Mapping[str, str]] = None,
                     step_package_id: Optional[str] = None,
                     community_action_template_id: Optional[str] = None,
                     description: Optional[str] = None,
                     git_dependencies: Optional[Sequence[StepTemplateGitDependencyArgs]] = None,
                     name: Optional[str] = None,
                     space_id: Optional[str] = None)
    func NewStepTemplate(ctx *Context, name string, args StepTemplateArgs, opts ...ResourceOption) (*StepTemplate, error)
    public StepTemplate(string name, StepTemplateArgs args, CustomResourceOptions? opts = null)
    public StepTemplate(String name, StepTemplateArgs args)
    public StepTemplate(String name, StepTemplateArgs args, CustomResourceOptions options)
    
    type: octopusdeploy:StepTemplate
    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 StepTemplateArgs
    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 StepTemplateArgs
    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 StepTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StepTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StepTemplateArgs
    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 stepTemplateResource = new Octopusdeploy.StepTemplate("stepTemplateResource", new()
    {
        ActionType = "string",
        Packages = new[]
        {
            new Octopusdeploy.Inputs.StepTemplatePackageArgs
            {
                FeedId = "string",
                Name = "string",
                Properties = new Octopusdeploy.Inputs.StepTemplatePackagePropertiesArgs
                {
                    SelectionMode = "string",
                    Extract = "string",
                    PackageParameterName = "string",
                    Purpose = "string",
                },
                AcquisitionLocation = "string",
                Id = "string",
                PackageId = "string",
            },
        },
        Parameters = new[]
        {
            new Octopusdeploy.Inputs.StepTemplateParameterArgs
            {
                Id = "string",
                Name = "string",
                DefaultValue = "string",
                DisplaySettings = 
                {
                    { "string", "string" },
                },
                HelpText = "string",
                Label = "string",
            },
        },
        Properties = 
        {
            { "string", "string" },
        },
        StepPackageId = "string",
        CommunityActionTemplateId = "string",
        Description = "string",
        GitDependencies = new[]
        {
            new Octopusdeploy.Inputs.StepTemplateGitDependencyArgs
            {
                DefaultBranch = "string",
                GitCredentialType = "string",
                RepositoryUri = "string",
                FilePathFilters = new[]
                {
                    "string",
                },
                GitCredentialId = "string",
                Name = "string",
            },
        },
        Name = "string",
        SpaceId = "string",
    });
    
    example, err := octopusdeploy.NewStepTemplate(ctx, "stepTemplateResource", &octopusdeploy.StepTemplateArgs{
    	ActionType: pulumi.String("string"),
    	Packages: octopusdeploy.StepTemplatePackageArray{
    		&octopusdeploy.StepTemplatePackageArgs{
    			FeedId: pulumi.String("string"),
    			Name:   pulumi.String("string"),
    			Properties: &octopusdeploy.StepTemplatePackagePropertiesArgs{
    				SelectionMode:        pulumi.String("string"),
    				Extract:              pulumi.String("string"),
    				PackageParameterName: pulumi.String("string"),
    				Purpose:              pulumi.String("string"),
    			},
    			AcquisitionLocation: pulumi.String("string"),
    			Id:                  pulumi.String("string"),
    			PackageId:           pulumi.String("string"),
    		},
    	},
    	Parameters: octopusdeploy.StepTemplateParameterArray{
    		&octopusdeploy.StepTemplateParameterArgs{
    			Id:           pulumi.String("string"),
    			Name:         pulumi.String("string"),
    			DefaultValue: pulumi.String("string"),
    			DisplaySettings: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			HelpText: pulumi.String("string"),
    			Label:    pulumi.String("string"),
    		},
    	},
    	Properties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	StepPackageId:             pulumi.String("string"),
    	CommunityActionTemplateId: pulumi.String("string"),
    	Description:               pulumi.String("string"),
    	GitDependencies: octopusdeploy.StepTemplateGitDependencyArray{
    		&octopusdeploy.StepTemplateGitDependencyArgs{
    			DefaultBranch:     pulumi.String("string"),
    			GitCredentialType: pulumi.String("string"),
    			RepositoryUri:     pulumi.String("string"),
    			FilePathFilters: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			GitCredentialId: pulumi.String("string"),
    			Name:            pulumi.String("string"),
    		},
    	},
    	Name:    pulumi.String("string"),
    	SpaceId: pulumi.String("string"),
    })
    
    var stepTemplateResource = new StepTemplate("stepTemplateResource", StepTemplateArgs.builder()
        .actionType("string")
        .packages(StepTemplatePackageArgs.builder()
            .feedId("string")
            .name("string")
            .properties(StepTemplatePackagePropertiesArgs.builder()
                .selectionMode("string")
                .extract("string")
                .packageParameterName("string")
                .purpose("string")
                .build())
            .acquisitionLocation("string")
            .id("string")
            .packageId("string")
            .build())
        .parameters(StepTemplateParameterArgs.builder()
            .id("string")
            .name("string")
            .defaultValue("string")
            .displaySettings(Map.of("string", "string"))
            .helpText("string")
            .label("string")
            .build())
        .properties(Map.of("string", "string"))
        .stepPackageId("string")
        .communityActionTemplateId("string")
        .description("string")
        .gitDependencies(StepTemplateGitDependencyArgs.builder()
            .defaultBranch("string")
            .gitCredentialType("string")
            .repositoryUri("string")
            .filePathFilters("string")
            .gitCredentialId("string")
            .name("string")
            .build())
        .name("string")
        .spaceId("string")
        .build());
    
    step_template_resource = octopusdeploy.StepTemplate("stepTemplateResource",
        action_type="string",
        packages=[{
            "feed_id": "string",
            "name": "string",
            "properties": {
                "selection_mode": "string",
                "extract": "string",
                "package_parameter_name": "string",
                "purpose": "string",
            },
            "acquisition_location": "string",
            "id": "string",
            "package_id": "string",
        }],
        parameters=[{
            "id": "string",
            "name": "string",
            "default_value": "string",
            "display_settings": {
                "string": "string",
            },
            "help_text": "string",
            "label": "string",
        }],
        properties={
            "string": "string",
        },
        step_package_id="string",
        community_action_template_id="string",
        description="string",
        git_dependencies=[{
            "default_branch": "string",
            "git_credential_type": "string",
            "repository_uri": "string",
            "file_path_filters": ["string"],
            "git_credential_id": "string",
            "name": "string",
        }],
        name="string",
        space_id="string")
    
    const stepTemplateResource = new octopusdeploy.StepTemplate("stepTemplateResource", {
        actionType: "string",
        packages: [{
            feedId: "string",
            name: "string",
            properties: {
                selectionMode: "string",
                extract: "string",
                packageParameterName: "string",
                purpose: "string",
            },
            acquisitionLocation: "string",
            id: "string",
            packageId: "string",
        }],
        parameters: [{
            id: "string",
            name: "string",
            defaultValue: "string",
            displaySettings: {
                string: "string",
            },
            helpText: "string",
            label: "string",
        }],
        properties: {
            string: "string",
        },
        stepPackageId: "string",
        communityActionTemplateId: "string",
        description: "string",
        gitDependencies: [{
            defaultBranch: "string",
            gitCredentialType: "string",
            repositoryUri: "string",
            filePathFilters: ["string"],
            gitCredentialId: "string",
            name: "string",
        }],
        name: "string",
        spaceId: "string",
    });
    
    type: octopusdeploy:StepTemplate
    properties:
        actionType: string
        communityActionTemplateId: string
        description: string
        gitDependencies:
            - defaultBranch: string
              filePathFilters:
                - string
              gitCredentialId: string
              gitCredentialType: string
              name: string
              repositoryUri: string
        name: string
        packages:
            - acquisitionLocation: string
              feedId: string
              id: string
              name: string
              packageId: string
              properties:
                extract: string
                packageParameterName: string
                purpose: string
                selectionMode: string
        parameters:
            - defaultValue: string
              displaySettings:
                string: string
              helpText: string
              id: string
              label: string
              name: string
        properties:
            string: string
        spaceId: string
        stepPackageId: string
    

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

    ActionType string
    The action type of the step template
    Packages List<StepTemplatePackage>
    Package information for the step template
    Parameters List<StepTemplateParameter>
    List of parameters that can be used in Step Template.
    Properties Dictionary<string, string>
    Properties for the step template
    StepPackageId string
    The ID of the step package
    CommunityActionTemplateId string
    The ID of the community action template
    Description string
    The description of this step_template.
    GitDependencies List<StepTemplateGitDependency>
    List of Git dependencies for the step template.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this step_template.
    ActionType string
    The action type of the step template
    Packages []StepTemplatePackageArgs
    Package information for the step template
    Parameters []StepTemplateParameterArgs
    List of parameters that can be used in Step Template.
    Properties map[string]string
    Properties for the step template
    StepPackageId string
    The ID of the step package
    CommunityActionTemplateId string
    The ID of the community action template
    Description string
    The description of this step_template.
    GitDependencies []StepTemplateGitDependencyArgs
    List of Git dependencies for the step template.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this step_template.
    actionType String
    The action type of the step template
    packages List<StepTemplatePackage>
    Package information for the step template
    parameters List<StepTemplateParameter>
    List of parameters that can be used in Step Template.
    properties Map<String,String>
    Properties for the step template
    stepPackageId String
    The ID of the step package
    communityActionTemplateId String
    The ID of the community action template
    description String
    The description of this step_template.
    gitDependencies List<StepTemplateGitDependency>
    List of Git dependencies for the step template.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this step_template.
    actionType string
    The action type of the step template
    packages StepTemplatePackage[]
    Package information for the step template
    parameters StepTemplateParameter[]
    List of parameters that can be used in Step Template.
    properties {[key: string]: string}
    Properties for the step template
    stepPackageId string
    The ID of the step package
    communityActionTemplateId string
    The ID of the community action template
    description string
    The description of this step_template.
    gitDependencies StepTemplateGitDependency[]
    List of Git dependencies for the step template.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this step_template.
    action_type str
    The action type of the step template
    packages Sequence[StepTemplatePackageArgs]
    Package information for the step template
    parameters Sequence[StepTemplateParameterArgs]
    List of parameters that can be used in Step Template.
    properties Mapping[str, str]
    Properties for the step template
    step_package_id str
    The ID of the step package
    community_action_template_id str
    The ID of the community action template
    description str
    The description of this step_template.
    git_dependencies Sequence[StepTemplateGitDependencyArgs]
    List of Git dependencies for the step template.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this step_template.
    actionType String
    The action type of the step template
    packages List<Property Map>
    Package information for the step template
    parameters List<Property Map>
    List of parameters that can be used in Step Template.
    properties Map<String>
    Properties for the step template
    stepPackageId String
    The ID of the step package
    communityActionTemplateId String
    The ID of the community action template
    description String
    The description of this step_template.
    gitDependencies List<Property Map>
    List of Git dependencies for the step template.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this step_template.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    The version of the step template
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    The version of the step template
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    The version of the step template
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the step template
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    The version of the step template
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the step template

    Look up Existing StepTemplate Resource

    Get an existing StepTemplate 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?: StepTemplateState, opts?: CustomResourceOptions): StepTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action_type: Optional[str] = None,
            community_action_template_id: Optional[str] = None,
            description: Optional[str] = None,
            git_dependencies: Optional[Sequence[StepTemplateGitDependencyArgs]] = None,
            name: Optional[str] = None,
            packages: Optional[Sequence[StepTemplatePackageArgs]] = None,
            parameters: Optional[Sequence[StepTemplateParameterArgs]] = None,
            properties: Optional[Mapping[str, str]] = None,
            space_id: Optional[str] = None,
            step_package_id: Optional[str] = None,
            version: Optional[float] = None) -> StepTemplate
    func GetStepTemplate(ctx *Context, name string, id IDInput, state *StepTemplateState, opts ...ResourceOption) (*StepTemplate, error)
    public static StepTemplate Get(string name, Input<string> id, StepTemplateState? state, CustomResourceOptions? opts = null)
    public static StepTemplate get(String name, Output<String> id, StepTemplateState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:StepTemplate    get:      id: ${id}
    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:
    ActionType string
    The action type of the step template
    CommunityActionTemplateId string
    The ID of the community action template
    Description string
    The description of this step_template.
    GitDependencies List<StepTemplateGitDependency>
    List of Git dependencies for the step template.
    Name string
    The name of this resource.
    Packages List<StepTemplatePackage>
    Package information for the step template
    Parameters List<StepTemplateParameter>
    List of parameters that can be used in Step Template.
    Properties Dictionary<string, string>
    Properties for the step template
    SpaceId string
    The space ID associated with this step_template.
    StepPackageId string
    The ID of the step package
    Version double
    The version of the step template
    ActionType string
    The action type of the step template
    CommunityActionTemplateId string
    The ID of the community action template
    Description string
    The description of this step_template.
    GitDependencies []StepTemplateGitDependencyArgs
    List of Git dependencies for the step template.
    Name string
    The name of this resource.
    Packages []StepTemplatePackageArgs
    Package information for the step template
    Parameters []StepTemplateParameterArgs
    List of parameters that can be used in Step Template.
    Properties map[string]string
    Properties for the step template
    SpaceId string
    The space ID associated with this step_template.
    StepPackageId string
    The ID of the step package
    Version float64
    The version of the step template
    actionType String
    The action type of the step template
    communityActionTemplateId String
    The ID of the community action template
    description String
    The description of this step_template.
    gitDependencies List<StepTemplateGitDependency>
    List of Git dependencies for the step template.
    name String
    The name of this resource.
    packages List<StepTemplatePackage>
    Package information for the step template
    parameters List<StepTemplateParameter>
    List of parameters that can be used in Step Template.
    properties Map<String,String>
    Properties for the step template
    spaceId String
    The space ID associated with this step_template.
    stepPackageId String
    The ID of the step package
    version Double
    The version of the step template
    actionType string
    The action type of the step template
    communityActionTemplateId string
    The ID of the community action template
    description string
    The description of this step_template.
    gitDependencies StepTemplateGitDependency[]
    List of Git dependencies for the step template.
    name string
    The name of this resource.
    packages StepTemplatePackage[]
    Package information for the step template
    parameters StepTemplateParameter[]
    List of parameters that can be used in Step Template.
    properties {[key: string]: string}
    Properties for the step template
    spaceId string
    The space ID associated with this step_template.
    stepPackageId string
    The ID of the step package
    version number
    The version of the step template
    action_type str
    The action type of the step template
    community_action_template_id str
    The ID of the community action template
    description str
    The description of this step_template.
    git_dependencies Sequence[StepTemplateGitDependencyArgs]
    List of Git dependencies for the step template.
    name str
    The name of this resource.
    packages Sequence[StepTemplatePackageArgs]
    Package information for the step template
    parameters Sequence[StepTemplateParameterArgs]
    List of parameters that can be used in Step Template.
    properties Mapping[str, str]
    Properties for the step template
    space_id str
    The space ID associated with this step_template.
    step_package_id str
    The ID of the step package
    version float
    The version of the step template
    actionType String
    The action type of the step template
    communityActionTemplateId String
    The ID of the community action template
    description String
    The description of this step_template.
    gitDependencies List<Property Map>
    List of Git dependencies for the step template.
    name String
    The name of this resource.
    packages List<Property Map>
    Package information for the step template
    parameters List<Property Map>
    List of parameters that can be used in Step Template.
    properties Map<String>
    Properties for the step template
    spaceId String
    The space ID associated with this step_template.
    stepPackageId String
    The ID of the step package
    version Number
    The version of the step template

    Supporting Types

    StepTemplateGitDependency, StepTemplateGitDependencyArgs

    DefaultBranch string
    Name of the default branch of the repository.
    GitCredentialType string
    The Git credential authentication type.
    RepositoryUri string
    The Git URI for the repository where this resource is sourced from.
    FilePathFilters List<string>
    List of file path filters used to narrow down the directory where files are to be sourced from.
    GitCredentialId string
    ID of an existing Git credential.
    Name string
    The name of the Git dependency.
    DefaultBranch string
    Name of the default branch of the repository.
    GitCredentialType string
    The Git credential authentication type.
    RepositoryUri string
    The Git URI for the repository where this resource is sourced from.
    FilePathFilters []string
    List of file path filters used to narrow down the directory where files are to be sourced from.
    GitCredentialId string
    ID of an existing Git credential.
    Name string
    The name of the Git dependency.
    defaultBranch String
    Name of the default branch of the repository.
    gitCredentialType String
    The Git credential authentication type.
    repositoryUri String
    The Git URI for the repository where this resource is sourced from.
    filePathFilters List<String>
    List of file path filters used to narrow down the directory where files are to be sourced from.
    gitCredentialId String
    ID of an existing Git credential.
    name String
    The name of the Git dependency.
    defaultBranch string
    Name of the default branch of the repository.
    gitCredentialType string
    The Git credential authentication type.
    repositoryUri string
    The Git URI for the repository where this resource is sourced from.
    filePathFilters string[]
    List of file path filters used to narrow down the directory where files are to be sourced from.
    gitCredentialId string
    ID of an existing Git credential.
    name string
    The name of the Git dependency.
    default_branch str
    Name of the default branch of the repository.
    git_credential_type str
    The Git credential authentication type.
    repository_uri str
    The Git URI for the repository where this resource is sourced from.
    file_path_filters Sequence[str]
    List of file path filters used to narrow down the directory where files are to be sourced from.
    git_credential_id str
    ID of an existing Git credential.
    name str
    The name of the Git dependency.
    defaultBranch String
    Name of the default branch of the repository.
    gitCredentialType String
    The Git credential authentication type.
    repositoryUri String
    The Git URI for the repository where this resource is sourced from.
    filePathFilters List<String>
    List of file path filters used to narrow down the directory where files are to be sourced from.
    gitCredentialId String
    ID of an existing Git credential.
    name String
    The name of the Git dependency.

    StepTemplatePackage, StepTemplatePackageArgs

    FeedId string
    ID of the feed.
    Name string
    The name of this resource.
    Properties StepTemplatePackageProperties
    Properties for the package.
    AcquisitionLocation string
    Acquisition location for the package.
    Id string
    The unique ID for this resource.
    PackageId string
    The ID of the package to use.
    FeedId string
    ID of the feed.
    Name string
    The name of this resource.
    Properties StepTemplatePackageProperties
    Properties for the package.
    AcquisitionLocation string
    Acquisition location for the package.
    Id string
    The unique ID for this resource.
    PackageId string
    The ID of the package to use.
    feedId String
    ID of the feed.
    name String
    The name of this resource.
    properties StepTemplatePackageProperties
    Properties for the package.
    acquisitionLocation String
    Acquisition location for the package.
    id String
    The unique ID for this resource.
    packageId String
    The ID of the package to use.
    feedId string
    ID of the feed.
    name string
    The name of this resource.
    properties StepTemplatePackageProperties
    Properties for the package.
    acquisitionLocation string
    Acquisition location for the package.
    id string
    The unique ID for this resource.
    packageId string
    The ID of the package to use.
    feed_id str
    ID of the feed.
    name str
    The name of this resource.
    properties StepTemplatePackageProperties
    Properties for the package.
    acquisition_location str
    Acquisition location for the package.
    id str
    The unique ID for this resource.
    package_id str
    The ID of the package to use.
    feedId String
    ID of the feed.
    name String
    The name of this resource.
    properties Property Map
    Properties for the package.
    acquisitionLocation String
    Acquisition location for the package.
    id String
    The unique ID for this resource.
    packageId String
    The ID of the package to use.

    StepTemplatePackageProperties, StepTemplatePackagePropertiesArgs

    SelectionMode string
    The selection mode.
    Extract string
    If the package should extract.
    PackageParameterName string
    The name of the package parameter
    Purpose string
    The purpose of this property.
    SelectionMode string
    The selection mode.
    Extract string
    If the package should extract.
    PackageParameterName string
    The name of the package parameter
    Purpose string
    The purpose of this property.
    selectionMode String
    The selection mode.
    extract String
    If the package should extract.
    packageParameterName String
    The name of the package parameter
    purpose String
    The purpose of this property.
    selectionMode string
    The selection mode.
    extract string
    If the package should extract.
    packageParameterName string
    The name of the package parameter
    purpose string
    The purpose of this property.
    selection_mode str
    The selection mode.
    extract str
    If the package should extract.
    package_parameter_name str
    The name of the package parameter
    purpose str
    The purpose of this property.
    selectionMode String
    The selection mode.
    extract String
    If the package should extract.
    packageParameterName String
    The name of the package parameter
    purpose String
    The purpose of this property.

    StepTemplateParameter, StepTemplateParameterArgs

    Id string
    The id for the property.
    Name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    DefaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    DisplaySettings Dictionary<string, string>
    The display settings for the parameter.
    HelpText string
    The help presented alongside the parameter input.
    Label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    Id string
    The id for the property.
    Name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    DefaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    DisplaySettings map[string]string
    The display settings for the parameter.
    HelpText string
    The help presented alongside the parameter input.
    Label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    id String
    The id for the property.
    name String
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue String
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings Map<String,String>
    The display settings for the parameter.
    helpText String
    The help presented alongside the parameter input.
    label String
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    id string
    The id for the property.
    name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings {[key: string]: string}
    The display settings for the parameter.
    helpText string
    The help presented alongside the parameter input.
    label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    id str
    The id for the property.
    name str
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    default_value str
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    display_settings Mapping[str, str]
    The display settings for the parameter.
    help_text str
    The help presented alongside the parameter input.
    label str
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    id String
    The id for the property.
    name String
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue String
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings Map<String>
    The display settings for the parameter.
    helpText String
    The help presented alongside the parameter input.
    label String
    The label shown beside the parameter when presented in the deployment process. Example: Server name.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs