Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Qovery
  3. API Docs
  4. AnnotationsGroup
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

qovery.AnnotationsGroup

Explore with Pulumi AI

qovery logo
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

    # qovery.AnnotationsGroup (Resource)

    Provides a Qovery annotations group resource

    Example

    import * as pulumi from "@pulumi/pulumi";
import * as qovery from "@ediri/qovery";

const annotationsGroup1 = new qovery.AnnotationsGroup("annotationsGroup1", {
    organizationId: qovery_organization.my_organization.id,
    annotations: {
        key1: "value1",
        key2: "value2",
    },
    scopes: [
        "PODS",
        "DEPLOYMENTS",
    ],
});

    import pulumi
import ediri_qovery as qovery

annotations_group1 = qovery.AnnotationsGroup("annotationsGroup1",
    organization_id=qovery_organization["my_organization"]["id"],
    annotations={
        "key1": "value1",
        "key2": "value2",
    },
    scopes=[
        "PODS",
        "DEPLOYMENTS",
    ])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qovery.NewAnnotationsGroup(ctx, "annotationsGroup1", &qovery.AnnotationsGroupArgs{
			OrganizationId: pulumi.Any(qovery_organization.My_organization.Id),
			Annotations: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
			Scopes: pulumi.StringArray{
				pulumi.String("PODS"),
				pulumi.String("DEPLOYMENTS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = ediri.Qovery;

return await Deployment.RunAsync(() => 
{
    var annotationsGroup1 = new Qovery.AnnotationsGroup("annotationsGroup1", new()
    {
        OrganizationId = qovery_organization.My_organization.Id,
        Annotations = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
        Scopes = new[]
        {
            "PODS",
            "DEPLOYMENTS",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.AnnotationsGroup;
import com.pulumi.qovery.AnnotationsGroupArgs;
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 annotationsGroup1 = new AnnotationsGroup("annotationsGroup1", AnnotationsGroupArgs.builder()
            .organizationId(qovery_organization.my_organization().id())
            .annotations(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .scopes(            
                "PODS",
                "DEPLOYMENTS")
            .build());

    }
}

    resources:
  annotationsGroup1:
    type: qovery:AnnotationsGroup
    properties:
      organizationId: ${qovery_organization.my_organization.id}
      annotations:
        key1: value1
        key2: value2
      scopes:
        - PODS
        - DEPLOYMENTS

    Create AnnotationsGroup Resource

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

    Constructor syntax

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

@overload
def AnnotationsGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     annotations: Optional[Mapping[str, str]] = None,
                     organization_id: Optional[str] = None,
                     scopes: Optional[Sequence[str]] = None,
                     name: Optional[str] = None)
    func NewAnnotationsGroup(ctx *Context, name string, args AnnotationsGroupArgs, opts ...ResourceOption) (*AnnotationsGroup, error)
    public AnnotationsGroup(string name, AnnotationsGroupArgs args, CustomResourceOptions? opts = null)
    public AnnotationsGroup(String name, AnnotationsGroupArgs args)
public AnnotationsGroup(String name, AnnotationsGroupArgs args, CustomResourceOptions options)

    type: qovery:AnnotationsGroup
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 AnnotationsGroupArgs
    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 AnnotationsGroupArgs
    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 AnnotationsGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnnotationsGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnnotationsGroupArgs
    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 annotationsGroupResource = new Qovery.AnnotationsGroup("annotationsGroupResource", new()
{
    Annotations = 
    {
        { "string", "string" },
    },
    OrganizationId = "string",
    Scopes = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := qovery.NewAnnotationsGroup(ctx, "annotationsGroupResource", &qovery.AnnotationsGroupArgs{
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OrganizationId: pulumi.String("string"),
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var annotationsGroupResource = new AnnotationsGroup("annotationsGroupResource", AnnotationsGroupArgs.builder()
    .annotations(Map.of("string", "string"))
    .organizationId("string")
    .scopes("string")
    .name("string")
    .build());

    annotations_group_resource = qovery.AnnotationsGroup("annotationsGroupResource",
    annotations={
        "string": "string",
    },
    organization_id="string",
    scopes=["string"],
    name="string")

    const annotationsGroupResource = new qovery.AnnotationsGroup("annotationsGroupResource", {
    annotations: {
        string: "string",
    },
    organizationId: "string",
    scopes: ["string"],
    name: "string",
});

    type: qovery:AnnotationsGroup
properties:
    annotations:
        string: string
    name: string
    organizationId: string
    scopes:
        - string

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

    Annotations Dictionary<string, string>
    annotations
    OrganizationId string
    Id of the organization.
    Scopes List<string>
    scopes of the annotations group
    Name string
    name of the annotations group
    Annotations map[string]string
    annotations
    OrganizationId string
    Id of the organization.
    Scopes []string
    scopes of the annotations group
    Name string
    name of the annotations group
    annotations Map<String,String>
    annotations
    organizationId String
    Id of the organization.
    scopes List<String>
    scopes of the annotations group
    name String
    name of the annotations group
    annotations {[key: string]: string}
    annotations
    organizationId string
    Id of the organization.
    scopes string[]
    scopes of the annotations group
    name string
    name of the annotations group
    annotations Mapping[str, str]
    annotations
    organization_id str
    Id of the organization.
    scopes Sequence[str]
    scopes of the annotations group
    name str
    name of the annotations group
    annotations Map<String>
    annotations
    organizationId String
    Id of the organization.
    scopes List<String>
    scopes of the annotations group
    name String
    name of the annotations group

    Outputs

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

    Get an existing AnnotationsGroup 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?: AnnotationsGroupState, opts?: CustomResourceOptions): AnnotationsGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None) -> AnnotationsGroup
    func GetAnnotationsGroup(ctx *Context, name string, id IDInput, state *AnnotationsGroupState, opts ...ResourceOption) (*AnnotationsGroup, error)
    public static AnnotationsGroup Get(string name, Input<string> id, AnnotationsGroupState? state, CustomResourceOptions? opts = null)
    public static AnnotationsGroup get(String name, Output<String> id, AnnotationsGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Annotations Dictionary<string, string>
    annotations
    Name string
    name of the annotations group
    OrganizationId string
    Id of the organization.
    Scopes List<string>
    scopes of the annotations group
    Annotations map[string]string
    annotations
    Name string
    name of the annotations group
    OrganizationId string
    Id of the organization.
    Scopes []string
    scopes of the annotations group
    annotations Map<String,String>
    annotations
    name String
    name of the annotations group
    organizationId String
    Id of the organization.
    scopes List<String>
    scopes of the annotations group
    annotations {[key: string]: string}
    annotations
    name string
    name of the annotations group
    organizationId string
    Id of the organization.
    scopes string[]
    scopes of the annotations group
    annotations Mapping[str, str]
    annotations
    name str
    name of the annotations group
    organization_id str
    Id of the organization.
    scopes Sequence[str]
    scopes of the annotations group
    annotations Map<String>
    annotations
    name String
    name of the annotations group
    organizationId String
    Id of the organization.
    scopes List<String>
    scopes of the annotations group

    Import

    $ pulumi import qovery:index/annotationsGroup:AnnotationsGroup my_qovery_annotations_group "<annotations_group_id>"

    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.
    qovery logo
    Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
    dirien/pulumi-qovery