Folder resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
//
// Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
//
const scmFolderExample = new scm.Folder("scm_folder_example", {
name: "scm_folder_example",
parent: "ngfw-shared",
description: "Managed by Pulumi",
});
//
// Creates a folder under the "scm_folder_example" folder created beforehand
//
const scmNestedFolderExample = new scm.Folder("scm_nested_folder_example", {
name: "scm_nested_folder_example",
parent: "scm_folder_example",
description: "Managed by Pulumi",
}, {
dependsOn: [scmFolderExample],
});
//
// Creates a snippet that will be associated to a folder
//
const scmSnippetExample = new scm.Snippet("scm_snippet_example", {
name: "scm_snippet_example",
description: "Managed by Pulumi",
});
//
// Creates a folder with an attached snippet
//
const scmFolderWithSnippets = new scm.Folder("scm_folder_with_snippets", {
name: "scm_folder_with_snippets",
parent: "ngfw-shared",
description: "Managed by Pulumi",
snippets: [scmSnippetExample.name],
});
//
// Creates a label that will be associated to a folder
//
const scmLabelExample = new scm.Label("scm_label_example", {
name: "scm_label_example",
description: "Managed by Pulumi",
});
//
// Creates a folder with an attached label
//
const scmFolderWithLabel = new scm.Folder("scm_folder_with_label", {
name: "scm_folder_with_label",
parent: "ngfw-shared",
description: "Managed by Pulumi",
labels: [scmLabelExample.name],
}, {
dependsOn: [scmLabelExample],
});
import pulumi
import pulumi_scm as scm
#
# Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
#
scm_folder_example = scm.Folder("scm_folder_example",
name="scm_folder_example",
parent="ngfw-shared",
description="Managed by Pulumi")
#
# Creates a folder under the "scm_folder_example" folder created beforehand
#
scm_nested_folder_example = scm.Folder("scm_nested_folder_example",
name="scm_nested_folder_example",
parent="scm_folder_example",
description="Managed by Pulumi",
opts = pulumi.ResourceOptions(depends_on=[scm_folder_example]))
#
# Creates a snippet that will be associated to a folder
#
scm_snippet_example = scm.Snippet("scm_snippet_example",
name="scm_snippet_example",
description="Managed by Pulumi")
#
# Creates a folder with an attached snippet
#
scm_folder_with_snippets = scm.Folder("scm_folder_with_snippets",
name="scm_folder_with_snippets",
parent="ngfw-shared",
description="Managed by Pulumi",
snippets=[scm_snippet_example.name])
#
# Creates a label that will be associated to a folder
#
scm_label_example = scm.Label("scm_label_example",
name="scm_label_example",
description="Managed by Pulumi")
#
# Creates a folder with an attached label
#
scm_folder_with_label = scm.Folder("scm_folder_with_label",
name="scm_folder_with_label",
parent="ngfw-shared",
description="Managed by Pulumi",
labels=[scm_label_example.name],
opts = pulumi.ResourceOptions(depends_on=[scm_label_example]))
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
scmFolderExample, err := scm.NewFolder(ctx, "scm_folder_example", &scm.FolderArgs{
Name: pulumi.String("scm_folder_example"),
Parent: pulumi.String("ngfw-shared"),
Description: pulumi.String("Managed by Pulumi"),
})
if err != nil {
return err
}
// Creates a folder under the "scm_folder_example" folder created beforehand
_, err = scm.NewFolder(ctx, "scm_nested_folder_example", &scm.FolderArgs{
Name: pulumi.String("scm_nested_folder_example"),
Parent: pulumi.String("scm_folder_example"),
Description: pulumi.String("Managed by Pulumi"),
}, pulumi.DependsOn([]pulumi.Resource{
scmFolderExample,
}))
if err != nil {
return err
}
// Creates a snippet that will be associated to a folder
scmSnippetExample, err := scm.NewSnippet(ctx, "scm_snippet_example", &scm.SnippetArgs{
Name: pulumi.String("scm_snippet_example"),
Description: pulumi.String("Managed by Pulumi"),
})
if err != nil {
return err
}
// Creates a folder with an attached snippet
_, err = scm.NewFolder(ctx, "scm_folder_with_snippets", &scm.FolderArgs{
Name: pulumi.String("scm_folder_with_snippets"),
Parent: pulumi.String("ngfw-shared"),
Description: pulumi.String("Managed by Pulumi"),
Snippets: pulumi.StringArray{
scmSnippetExample.Name,
},
})
if err != nil {
return err
}
// Creates a label that will be associated to a folder
scmLabelExample, err := scm.NewLabel(ctx, "scm_label_example", &scm.LabelArgs{
Name: pulumi.String("scm_label_example"),
Description: pulumi.String("Managed by Pulumi"),
})
if err != nil {
return err
}
// Creates a folder with an attached label
_, err = scm.NewFolder(ctx, "scm_folder_with_label", &scm.FolderArgs{
Name: pulumi.String("scm_folder_with_label"),
Parent: pulumi.String("ngfw-shared"),
Description: pulumi.String("Managed by Pulumi"),
Labels: pulumi.StringArray{
scmLabelExample.Name,
},
}, pulumi.DependsOn([]pulumi.Resource{
scmLabelExample,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
//
// Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
//
var scmFolderExample = new Scm.Folder("scm_folder_example", new()
{
Name = "scm_folder_example",
Parent = "ngfw-shared",
Description = "Managed by Pulumi",
});
//
// Creates a folder under the "scm_folder_example" folder created beforehand
//
var scmNestedFolderExample = new Scm.Folder("scm_nested_folder_example", new()
{
Name = "scm_nested_folder_example",
Parent = "scm_folder_example",
Description = "Managed by Pulumi",
}, new CustomResourceOptions
{
DependsOn =
{
scmFolderExample,
},
});
//
// Creates a snippet that will be associated to a folder
//
var scmSnippetExample = new Scm.Snippet("scm_snippet_example", new()
{
Name = "scm_snippet_example",
Description = "Managed by Pulumi",
});
//
// Creates a folder with an attached snippet
//
var scmFolderWithSnippets = new Scm.Folder("scm_folder_with_snippets", new()
{
Name = "scm_folder_with_snippets",
Parent = "ngfw-shared",
Description = "Managed by Pulumi",
Snippets = new[]
{
scmSnippetExample.Name,
},
});
//
// Creates a label that will be associated to a folder
//
var scmLabelExample = new Scm.Label("scm_label_example", new()
{
Name = "scm_label_example",
Description = "Managed by Pulumi",
});
//
// Creates a folder with an attached label
//
var scmFolderWithLabel = new Scm.Folder("scm_folder_with_label", new()
{
Name = "scm_folder_with_label",
Parent = "ngfw-shared",
Description = "Managed by Pulumi",
Labels = new[]
{
scmLabelExample.Name,
},
}, new CustomResourceOptions
{
DependsOn =
{
scmLabelExample,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.Folder;
import com.pulumi.scm.FolderArgs;
import com.pulumi.scm.Snippet;
import com.pulumi.scm.SnippetArgs;
import com.pulumi.scm.Label;
import com.pulumi.scm.LabelArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
//
// Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
//
var scmFolderExample = new Folder("scmFolderExample", FolderArgs.builder()
.name("scm_folder_example")
.parent("ngfw-shared")
.description("Managed by Pulumi")
.build());
//
// Creates a folder under the "scm_folder_example" folder created beforehand
//
var scmNestedFolderExample = new Folder("scmNestedFolderExample", FolderArgs.builder()
.name("scm_nested_folder_example")
.parent("scm_folder_example")
.description("Managed by Pulumi")
.build(), CustomResourceOptions.builder()
.dependsOn(scmFolderExample)
.build());
//
// Creates a snippet that will be associated to a folder
//
var scmSnippetExample = new Snippet("scmSnippetExample", SnippetArgs.builder()
.name("scm_snippet_example")
.description("Managed by Pulumi")
.build());
//
// Creates a folder with an attached snippet
//
var scmFolderWithSnippets = new Folder("scmFolderWithSnippets", FolderArgs.builder()
.name("scm_folder_with_snippets")
.parent("ngfw-shared")
.description("Managed by Pulumi")
.snippets(scmSnippetExample.name())
.build());
//
// Creates a label that will be associated to a folder
//
var scmLabelExample = new Label("scmLabelExample", LabelArgs.builder()
.name("scm_label_example")
.description("Managed by Pulumi")
.build());
//
// Creates a folder with an attached label
//
var scmFolderWithLabel = new Folder("scmFolderWithLabel", FolderArgs.builder()
.name("scm_folder_with_label")
.parent("ngfw-shared")
.description("Managed by Pulumi")
.labels(scmLabelExample.name())
.build(), CustomResourceOptions.builder()
.dependsOn(scmLabelExample)
.build());
}
}
resources:
#
# Creates a folder under the "All Firewalls" aka "ngfw-shared" folder
#
scmFolderExample:
type: scm:Folder
name: scm_folder_example
properties:
name: scm_folder_example
parent: ngfw-shared
description: Managed by Pulumi
#
# Creates a folder under the "scm_folder_example" folder created beforehand
#
scmNestedFolderExample:
type: scm:Folder
name: scm_nested_folder_example
properties:
name: scm_nested_folder_example
parent: scm_folder_example
description: Managed by Pulumi
options:
dependsOn:
- ${scmFolderExample}
#
# Creates a snippet that will be associated to a folder
#
scmSnippetExample:
type: scm:Snippet
name: scm_snippet_example
properties:
name: scm_snippet_example
description: Managed by Pulumi
#
# Creates a folder with an attached snippet
#
scmFolderWithSnippets:
type: scm:Folder
name: scm_folder_with_snippets
properties:
name: scm_folder_with_snippets
parent: ngfw-shared
description: Managed by Pulumi
snippets:
- ${scmSnippetExample.name}
#
# Creates a label that will be associated to a folder
#
scmLabelExample:
type: scm:Label
name: scm_label_example
properties:
name: scm_label_example
description: Managed by Pulumi
#
# Creates a folder with an attached label
#
scmFolderWithLabel:
type: scm:Folder
name: scm_folder_with_label
properties:
name: scm_folder_with_label
parent: ngfw-shared
description: Managed by Pulumi
labels:
- ${scmLabelExample.name}
options:
dependsOn:
- ${scmLabelExample}
Create Folder Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);@overload
def Folder(resource_name: str,
args: FolderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Folder(resource_name: str,
opts: Optional[ResourceOptions] = None,
parent: Optional[str] = None,
description: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
snippets: Optional[Sequence[str]] = None)func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)
type: scm:Folder
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 FolderArgs
- 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 FolderArgs
- 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 FolderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FolderArgs
- 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 folderResource = new Scm.Folder("folderResource", new()
{
Parent = "string",
Description = "string",
Labels = new[]
{
"string",
},
Name = "string",
Snippets = new[]
{
"string",
},
});
example, err := scm.NewFolder(ctx, "folderResource", &scm.FolderArgs{
Parent: pulumi.String("string"),
Description: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Snippets: pulumi.StringArray{
pulumi.String("string"),
},
})
var folderResource = new Folder("folderResource", FolderArgs.builder()
.parent("string")
.description("string")
.labels("string")
.name("string")
.snippets("string")
.build());
folder_resource = scm.Folder("folderResource",
parent="string",
description="string",
labels=["string"],
name="string",
snippets=["string"])
const folderResource = new scm.Folder("folderResource", {
parent: "string",
description: "string",
labels: ["string"],
name: "string",
snippets: ["string"],
});
type: scm:Folder
properties:
description: string
labels:
- string
name: string
parent: string
snippets:
- string
Folder 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 Folder resource accepts the following input properties:
- Parent string
- The parent folder
- Description string
- The description of the folder
- Labels List<string>
- Labels assigned to the folder
- Name string
- The name of the folder
- Snippets List<string>
- Snippets associated with the folder
- Parent string
- The parent folder
- Description string
- The description of the folder
- Labels []string
- Labels assigned to the folder
- Name string
- The name of the folder
- Snippets []string
- Snippets associated with the folder
- parent String
- The parent folder
- description String
- The description of the folder
- labels List<String>
- Labels assigned to the folder
- name String
- The name of the folder
- snippets List<String>
- Snippets associated with the folder
- parent string
- The parent folder
- description string
- The description of the folder
- labels string[]
- Labels assigned to the folder
- name string
- The name of the folder
- snippets string[]
- Snippets associated with the folder
- parent str
- The parent folder
- description str
- The description of the folder
- labels Sequence[str]
- Labels assigned to the folder
- name str
- The name of the folder
- snippets Sequence[str]
- Snippets associated with the folder
- parent String
- The parent folder
- description String
- The description of the folder
- labels List<String>
- Labels assigned to the folder
- name String
- The name of the folder
- snippets List<String>
- Snippets associated with the folder
Outputs
All input properties are implicitly available as output properties. Additionally, the Folder resource produces the following output properties:
Look up Existing Folder Resource
Get an existing Folder 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?: FolderState, opts?: CustomResourceOptions): Folder@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
snippets: Optional[Sequence[str]] = None,
tfid: Optional[str] = None) -> Folderfunc GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)public static Folder get(String name, Output<String> id, FolderState state, CustomResourceOptions options)resources: _: type: scm:Folder 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.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
