1. Packages
  2. Qovery
  3. API Docs
  4. LabelsGroup
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien

qovery.LabelsGroup

Explore with Pulumi AI

# qovery.LabelsGroup (Resource)

Provides a Qovery labels group resource

Example

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.LabelsGroup;
import com.pulumi.qovery.LabelsGroupArgs;
import com.pulumi.qovery.inputs.LabelsGroupLabelArgs;
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 labelsGroup1 = new LabelsGroup("labelsGroup1", LabelsGroupArgs.builder()
            .organizationId(qovery_organization.my_organization().id())
            .labels(            
                LabelsGroupLabelArgs.builder()
                    .key("key1")
                    .value("value1")
                    .propagate_to_cloud_provider(false)
                    .build(),
                LabelsGroupLabelArgs.builder()
                    .key("key2")
                    .value("value2")
                    .propagate_to_cloud_provider(true)
                    .build())
            .build());

    }
}
Copy
resources:
  labelsGroup1:
    type: qovery:LabelsGroup
    properties:
      organizationId: ${qovery_organization.my_organization.id}
      labels:
        - key: key1
          value: value1
          propagate_to_cloud_provider: false
        - key: key2
          value: value2
          propagate_to_cloud_provider: true
Copy

Create LabelsGroup Resource

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

Constructor syntax

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

@overload
def LabelsGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                labels: Optional[Sequence[LabelsGroupLabelArgs]] = None,
                organization_id: Optional[str] = None,
                name: Optional[str] = None)
func NewLabelsGroup(ctx *Context, name string, args LabelsGroupArgs, opts ...ResourceOption) (*LabelsGroup, error)
public LabelsGroup(string name, LabelsGroupArgs args, CustomResourceOptions? opts = null)
public LabelsGroup(String name, LabelsGroupArgs args)
public LabelsGroup(String name, LabelsGroupArgs args, CustomResourceOptions options)
type: qovery:LabelsGroup
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. LabelsGroupArgs
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. LabelsGroupArgs
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. LabelsGroupArgs
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. LabelsGroupArgs
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. LabelsGroupArgs
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 labelsGroupResource = new Qovery.LabelsGroup("labelsGroupResource", new()
{
    Labels = new[]
    {
        new Qovery.Inputs.LabelsGroupLabelArgs
        {
            Key = "string",
            PropagateToCloudProvider = false,
            Value = "string",
        },
    },
    OrganizationId = "string",
    Name = "string",
});
Copy
example, err := qovery.NewLabelsGroup(ctx, "labelsGroupResource", &qovery.LabelsGroupArgs{
	Labels: qovery.LabelsGroupLabelArray{
		&qovery.LabelsGroupLabelArgs{
			Key:                      pulumi.String("string"),
			PropagateToCloudProvider: pulumi.Bool(false),
			Value:                    pulumi.String("string"),
		},
	},
	OrganizationId: pulumi.String("string"),
	Name:           pulumi.String("string"),
})
Copy
var labelsGroupResource = new LabelsGroup("labelsGroupResource", LabelsGroupArgs.builder()
    .labels(LabelsGroupLabelArgs.builder()
        .key("string")
        .propagateToCloudProvider(false)
        .value("string")
        .build())
    .organizationId("string")
    .name("string")
    .build());
Copy
labels_group_resource = qovery.LabelsGroup("labelsGroupResource",
    labels=[{
        "key": "string",
        "propagate_to_cloud_provider": False,
        "value": "string",
    }],
    organization_id="string",
    name="string")
Copy
const labelsGroupResource = new qovery.LabelsGroup("labelsGroupResource", {
    labels: [{
        key: "string",
        propagateToCloudProvider: false,
        value: "string",
    }],
    organizationId: "string",
    name: "string",
});
Copy
type: qovery:LabelsGroup
properties:
    labels:
        - key: string
          propagateToCloudProvider: false
          value: string
    name: string
    organizationId: string
Copy

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

Labels This property is required. List<ediri.Qovery.Inputs.LabelsGroupLabel>
labels
OrganizationId This property is required. string
Id of the organization.
Name string
name of the labels group
Labels This property is required. []LabelsGroupLabelArgs
labels
OrganizationId This property is required. string
Id of the organization.
Name string
name of the labels group
labels This property is required. List<LabelsGroupLabel>
labels
organizationId This property is required. String
Id of the organization.
name String
name of the labels group
labels This property is required. LabelsGroupLabel[]
labels
organizationId This property is required. string
Id of the organization.
name string
name of the labels group
labels This property is required. Sequence[LabelsGroupLabelArgs]
labels
organization_id This property is required. str
Id of the organization.
name str
name of the labels group
labels This property is required. List<Property Map>
labels
organizationId This property is required. String
Id of the organization.
name String
name of the labels group

Outputs

All input properties are implicitly available as output properties. Additionally, the LabelsGroup 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 LabelsGroup Resource

Get an existing LabelsGroup 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?: LabelsGroupState, opts?: CustomResourceOptions): LabelsGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        labels: Optional[Sequence[LabelsGroupLabelArgs]] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None) -> LabelsGroup
func GetLabelsGroup(ctx *Context, name string, id IDInput, state *LabelsGroupState, opts ...ResourceOption) (*LabelsGroup, error)
public static LabelsGroup Get(string name, Input<string> id, LabelsGroupState? state, CustomResourceOptions? opts = null)
public static LabelsGroup get(String name, Output<String> id, LabelsGroupState state, CustomResourceOptions options)
resources:  _:    type: qovery:LabelsGroup    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:
Labels List<ediri.Qovery.Inputs.LabelsGroupLabel>
labels
Name string
name of the labels group
OrganizationId string
Id of the organization.
Labels []LabelsGroupLabelArgs
labels
Name string
name of the labels group
OrganizationId string
Id of the organization.
labels List<LabelsGroupLabel>
labels
name String
name of the labels group
organizationId String
Id of the organization.
labels LabelsGroupLabel[]
labels
name string
name of the labels group
organizationId string
Id of the organization.
labels Sequence[LabelsGroupLabelArgs]
labels
name str
name of the labels group
organization_id str
Id of the organization.
labels List<Property Map>
labels
name String
name of the labels group
organizationId String
Id of the organization.

Supporting Types

LabelsGroupLabel
, LabelsGroupLabelArgs

Key This property is required. string
PropagateToCloudProvider This property is required. bool
Value This property is required. string
Key This property is required. string
PropagateToCloudProvider This property is required. bool
Value This property is required. string
key This property is required. String
propagateToCloudProvider This property is required. Boolean
value This property is required. String
key This property is required. string
propagateToCloudProvider This property is required. boolean
value This property is required. string
key This property is required. str
propagate_to_cloud_provider This property is required. bool
value This property is required. str
key This property is required. String
propagateToCloudProvider This property is required. Boolean
value This property is required. String

Import

$ pulumi import qovery:index/labelsGroup:LabelsGroup my_qovery_labels_group "<labels_group_id>"
Copy

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

Package Details

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