Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. AttributeGroup
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.AttributeGroup

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Attribute Groups allow you to define a set of referenced Attribute Definitions for the purpose of giving one or more dedicated teams access to edit Attribute values in Product Variants for those Attributes in the Merchant Center. Depending on the use case, editing permission can be granted to all Attributes, to Attributes that are ungrouped, or none.

    Example Usage

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

const my_attribute_group = new commercetools.AttributeGroup("my-attribute-group", {
    attributes: [
        {
            key: "attribute-key-1",
        },
        {
            key: "attribute-key-2",
        },
    ],
    description: {
        en: "my-attribute-group-description",
    },
    key: "my-attribute-group-key",
    name: {
        en: "my-attribute-group-name",
    },
});

    import pulumi
import pulumi_commercetools as commercetools

my_attribute_group = commercetools.AttributeGroup("my-attribute-group",
    attributes=[
        {
            "key": "attribute-key-1",
        },
        {
            "key": "attribute-key-2",
        },
    ],
    description={
        "en": "my-attribute-group-description",
    },
    key="my-attribute-group-key",
    name={
        "en": "my-attribute-group-name",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := commercetools.NewAttributeGroup(ctx, "my-attribute-group", &commercetools.AttributeGroupArgs{
			Attributes: commercetools.AttributeGroupAttributeArray{
				&commercetools.AttributeGroupAttributeArgs{
					Key: pulumi.String("attribute-key-1"),
				},
				&commercetools.AttributeGroupAttributeArgs{
					Key: pulumi.String("attribute-key-2"),
				},
			},
			Description: pulumi.StringMap{
				"en": pulumi.String("my-attribute-group-description"),
			},
			Key: pulumi.String("my-attribute-group-key"),
			Name: pulumi.StringMap{
				"en": pulumi.String("my-attribute-group-name"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var my_attribute_group = new Commercetools.AttributeGroup("my-attribute-group", new()
    {
        Attributes = new[]
        {
            new Commercetools.Inputs.AttributeGroupAttributeArgs
            {
                Key = "attribute-key-1",
            },
            new Commercetools.Inputs.AttributeGroupAttributeArgs
            {
                Key = "attribute-key-2",
            },
        },
        Description = 
        {
            { "en", "my-attribute-group-description" },
        },
        Key = "my-attribute-group-key",
        Name = 
        {
            { "en", "my-attribute-group-name" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.AttributeGroup;
import com.pulumi.commercetools.AttributeGroupArgs;
import com.pulumi.commercetools.inputs.AttributeGroupAttributeArgs;
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 my_attribute_group = new AttributeGroup("my-attribute-group", AttributeGroupArgs.builder()
            .attributes(            
                AttributeGroupAttributeArgs.builder()
                    .key("attribute-key-1")
                    .build(),
                AttributeGroupAttributeArgs.builder()
                    .key("attribute-key-2")
                    .build())
            .description(Map.of("en", "my-attribute-group-description"))
            .key("my-attribute-group-key")
            .name(Map.of("en", "my-attribute-group-name"))
            .build());

    }
}

    resources:
  my-attribute-group:
    type: commercetools:AttributeGroup
    properties:
      attributes:
        - key: attribute-key-1
        - key: attribute-key-2
      description:
        en: my-attribute-group-description
      key: my-attribute-group-key
      name:
        en: my-attribute-group-name

    Create AttributeGroup Resource

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

    Constructor syntax

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

@overload
def AttributeGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[Mapping[str, str]] = None,
                   attributes: Optional[Sequence[AttributeGroupAttributeArgs]] = None,
                   description: Optional[Mapping[str, str]] = None,
                   key: Optional[str] = None)
    func NewAttributeGroup(ctx *Context, name string, args AttributeGroupArgs, opts ...ResourceOption) (*AttributeGroup, error)
    public AttributeGroup(string name, AttributeGroupArgs args, CustomResourceOptions? opts = null)
    public AttributeGroup(String name, AttributeGroupArgs args)
public AttributeGroup(String name, AttributeGroupArgs args, CustomResourceOptions options)

    type: commercetools:AttributeGroup
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 AttributeGroupArgs
    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 AttributeGroupArgs
    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 AttributeGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AttributeGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AttributeGroupArgs
    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 attributeGroupResource = new Commercetools.AttributeGroup("attributeGroupResource", new()
{
    Name = 
    {
        { "string", "string" },
    },
    Attributes = new[]
    {
        new Commercetools.Inputs.AttributeGroupAttributeArgs
        {
            Key = "string",
        },
    },
    Description = 
    {
        { "string", "string" },
    },
    Key = "string",
});

    example, err := commercetools.NewAttributeGroup(ctx, "attributeGroupResource", &commercetools.AttributeGroupArgs{
Name: pulumi.StringMap{
"string": pulumi.String("string"),
},
Attributes: .AttributeGroupAttributeArray{
&.AttributeGroupAttributeArgs{
Key: pulumi.String("string"),
},
},
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
Key: pulumi.String("string"),
})

    var attributeGroupResource = new AttributeGroup("attributeGroupResource", AttributeGroupArgs.builder()
    .name(Map.of("string", "string"))
    .attributes(AttributeGroupAttributeArgs.builder()
        .key("string")
        .build())
    .description(Map.of("string", "string"))
    .key("string")
    .build());

    attribute_group_resource = commercetools.AttributeGroup("attributeGroupResource",
    name={
        "string": "string",
    },
    attributes=[{
        "key": "string",
    }],
    description={
        "string": "string",
    },
    key="string")

    const attributeGroupResource = new commercetools.AttributeGroup("attributeGroupResource", {
    name: {
        string: "string",
    },
    attributes: [{
        key: "string",
    }],
    description: {
        string: "string",
    },
    key: "string",
});

    type: commercetools:AttributeGroup
properties:
    attributes:
        - key: string
    description:
        string: string
    key: string
    name:
        string: string

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

    Name Dictionary<string, string>
    Name of the State as localized string.
    Attributes List<AttributeGroupAttribute>
    Attributes with unique values.
    Description Dictionary<string, string>
    Description of the State as localized string.
    Key string
    User-defined unique identifier of the AttributeGroup.
    Name map[string]string
    Name of the State as localized string.
    Attributes []AttributeGroupAttributeArgs
    Attributes with unique values.
    Description map[string]string
    Description of the State as localized string.
    Key string
    User-defined unique identifier of the AttributeGroup.
    name Map<String,String>
    Name of the State as localized string.
    attributes List<AttributeGroupAttribute>
    Attributes with unique values.
    description Map<String,String>
    Description of the State as localized string.
    key String
    User-defined unique identifier of the AttributeGroup.
    name {[key: string]: string}
    Name of the State as localized string.
    attributes AttributeGroupAttribute[]
    Attributes with unique values.
    description {[key: string]: string}
    Description of the State as localized string.
    key string
    User-defined unique identifier of the AttributeGroup.
    name Mapping[str, str]
    Name of the State as localized string.
    attributes Sequence[AttributeGroupAttributeArgs]
    Attributes with unique values.
    description Mapping[str, str]
    Description of the State as localized string.
    key str
    User-defined unique identifier of the AttributeGroup.
    name Map<String>
    Name of the State as localized string.
    attributes List<Property Map>
    Attributes with unique values.
    description Map<String>
    Description of the State as localized string.
    key String
    User-defined unique identifier of the AttributeGroup.

    Outputs

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

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

    Look up Existing AttributeGroup Resource

    Get an existing AttributeGroup 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?: AttributeGroupState, opts?: CustomResourceOptions): AttributeGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[Sequence[AttributeGroupAttributeArgs]] = None,
        description: Optional[Mapping[str, str]] = None,
        key: Optional[str] = None,
        name: Optional[Mapping[str, str]] = None,
        version: Optional[float] = None) -> AttributeGroup
    func GetAttributeGroup(ctx *Context, name string, id IDInput, state *AttributeGroupState, opts ...ResourceOption) (*AttributeGroup, error)
    public static AttributeGroup Get(string name, Input<string> id, AttributeGroupState? state, CustomResourceOptions? opts = null)
    public static AttributeGroup get(String name, Output<String> id, AttributeGroupState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:AttributeGroup    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:
    Attributes List<AttributeGroupAttribute>
    Attributes with unique values.
    Description Dictionary<string, string>
    Description of the State as localized string.
    Key string
    User-defined unique identifier of the AttributeGroup.
    Name Dictionary<string, string>
    Name of the State as localized string.
    Version double
    Current version of the AttributeGroup.
    Attributes []AttributeGroupAttributeArgs
    Attributes with unique values.
    Description map[string]string
    Description of the State as localized string.
    Key string
    User-defined unique identifier of the AttributeGroup.
    Name map[string]string
    Name of the State as localized string.
    Version float64
    Current version of the AttributeGroup.
    attributes List<AttributeGroupAttribute>
    Attributes with unique values.
    description Map<String,String>
    Description of the State as localized string.
    key String
    User-defined unique identifier of the AttributeGroup.
    name Map<String,String>
    Name of the State as localized string.
    version Double
    Current version of the AttributeGroup.
    attributes AttributeGroupAttribute[]
    Attributes with unique values.
    description {[key: string]: string}
    Description of the State as localized string.
    key string
    User-defined unique identifier of the AttributeGroup.
    name {[key: string]: string}
    Name of the State as localized string.
    version number
    Current version of the AttributeGroup.
    attributes Sequence[AttributeGroupAttributeArgs]
    Attributes with unique values.
    description Mapping[str, str]
    Description of the State as localized string.
    key str
    User-defined unique identifier of the AttributeGroup.
    name Mapping[str, str]
    Name of the State as localized string.
    version float
    Current version of the AttributeGroup.
    attributes List<Property Map>
    Attributes with unique values.
    description Map<String>
    Description of the State as localized string.
    key String
    User-defined unique identifier of the AttributeGroup.
    name Map<String>
    Name of the State as localized string.
    version Number
    Current version of the AttributeGroup.

    Supporting Types

    AttributeGroupAttribute, AttributeGroupAttributeArgs

    Key string
    The Attribute's name as given in its AttributeDefinition.
    Key string
    The Attribute's name as given in its AttributeDefinition.
    key String
    The Attribute's name as given in its AttributeDefinition.
    key string
    The Attribute's name as given in its AttributeDefinition.
    key str
    The Attribute's name as given in its AttributeDefinition.
    key String
    The Attribute's name as given in its AttributeDefinition.

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools