1. Packages
  2. Yandex
  3. API Docs
  4. ResourcemanagerFolder
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

yandex.ResourcemanagerFolder

Explore with Pulumi AI

Allows creation and management of Cloud Folders for an existing Yandex Cloud. See the official documentation for additional info. Note: deletion of folders may take up to 30 minutes as it requires a lot of communication between cloud services.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var folder1 = new Yandex.ResourcemanagerFolder("folder1", new Yandex.ResourcemanagerFolderArgs
        {
            CloudId = "my_cloud_id",
        });
    }

}
Copy
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := yandex.NewResourcemanagerFolder(ctx, "folder1", &yandex.ResourcemanagerFolderArgs{
			CloudId: pulumi.String("my_cloud_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const folder1 = new yandex.ResourcemanagerFolder("folder1", {
    cloudId: "my_cloud_id",
});
Copy
import pulumi
import pulumi_yandex as yandex

folder1 = yandex.ResourcemanagerFolder("folder1", cloud_id="my_cloud_id")
Copy

Coming soon!

Create ResourcemanagerFolder Resource

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

Constructor syntax

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

@overload
def ResourcemanagerFolder(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cloud_id: Optional[str] = None,
                          description: Optional[str] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None)
func NewResourcemanagerFolder(ctx *Context, name string, args *ResourcemanagerFolderArgs, opts ...ResourceOption) (*ResourcemanagerFolder, error)
public ResourcemanagerFolder(string name, ResourcemanagerFolderArgs? args = null, CustomResourceOptions? opts = null)
public ResourcemanagerFolder(String name, ResourcemanagerFolderArgs args)
public ResourcemanagerFolder(String name, ResourcemanagerFolderArgs args, CustomResourceOptions options)
type: yandex:ResourcemanagerFolder
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 ResourcemanagerFolderArgs
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 ResourcemanagerFolderArgs
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 ResourcemanagerFolderArgs
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 ResourcemanagerFolderArgs
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. ResourcemanagerFolderArgs
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 resourcemanagerFolderResource = new Yandex.ResourcemanagerFolder("resourcemanagerFolderResource", new()
{
    CloudId = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := yandex.NewResourcemanagerFolder(ctx, "resourcemanagerFolderResource", &yandex.ResourcemanagerFolderArgs{
	CloudId:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var resourcemanagerFolderResource = new ResourcemanagerFolder("resourcemanagerFolderResource", ResourcemanagerFolderArgs.builder()
    .cloudId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .build());
Copy
resourcemanager_folder_resource = yandex.ResourcemanagerFolder("resourcemanagerFolderResource",
    cloud_id="string",
    description="string",
    labels={
        "string": "string",
    },
    name="string")
Copy
const resourcemanagerFolderResource = new yandex.ResourcemanagerFolder("resourcemanagerFolderResource", {
    cloudId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    name: "string",
});
Copy
type: yandex:ResourcemanagerFolder
properties:
    cloudId: string
    description: string
    labels:
        string: string
    name: string
Copy

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

CloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
Description string
A description of the Folder.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Folder.
Name string
The name of the Folder.
CloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
Description string
A description of the Folder.
Labels map[string]string
A set of key/value label pairs to assign to the Folder.
Name string
The name of the Folder.
cloudId String
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
description String
A description of the Folder.
labels Map<String,String>
A set of key/value label pairs to assign to the Folder.
name String
The name of the Folder.
cloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
description string
A description of the Folder.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Folder.
name string
The name of the Folder.
cloud_id str
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
description str
A description of the Folder.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Folder.
name str
The name of the Folder.
cloudId String
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
description String
A description of the Folder.
labels Map<String>
A set of key/value label pairs to assign to the Folder.
name String
The name of the Folder.

Outputs

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

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

Look up Existing ResourcemanagerFolder Resource

Get an existing ResourcemanagerFolder 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?: ResourcemanagerFolderState, opts?: CustomResourceOptions): ResourcemanagerFolder
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_id: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None) -> ResourcemanagerFolder
func GetResourcemanagerFolder(ctx *Context, name string, id IDInput, state *ResourcemanagerFolderState, opts ...ResourceOption) (*ResourcemanagerFolder, error)
public static ResourcemanagerFolder Get(string name, Input<string> id, ResourcemanagerFolderState? state, CustomResourceOptions? opts = null)
public static ResourcemanagerFolder get(String name, Output<String> id, ResourcemanagerFolderState state, CustomResourceOptions options)
resources:  _:    type: yandex:ResourcemanagerFolder    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:
CloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
CreatedAt string
Description string
A description of the Folder.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Folder.
Name string
The name of the Folder.
CloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
CreatedAt string
Description string
A description of the Folder.
Labels map[string]string
A set of key/value label pairs to assign to the Folder.
Name string
The name of the Folder.
cloudId String
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
createdAt String
description String
A description of the Folder.
labels Map<String,String>
A set of key/value label pairs to assign to the Folder.
name String
The name of the Folder.
cloudId string
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
createdAt string
description string
A description of the Folder.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Folder.
name string
The name of the Folder.
cloud_id str
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
created_at str
description str
A description of the Folder.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Folder.
name str
The name of the Folder.
cloudId String
Cloud that the resource belongs to. If value is omitted, the default provider Cloud ID is used.
createdAt String
description String
A description of the Folder.
labels Map<String>
A set of key/value label pairs to assign to the Folder.
name String
The name of the Folder.

Package Details

Repository
Yandex pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.