1. Packages
  2. AWS
  3. API Docs
  4. iot
  5. BillingGroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.iot.BillingGroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an AWS IoT Billing Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.iot.BillingGroup("example", {
        name: "example",
        properties: {
            description: "This is my billing group",
        },
        tags: {
            terraform: "true",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.iot.BillingGroup("example",
        name="example",
        properties={
            "description": "This is my billing group",
        },
        tags={
            "terraform": "true",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iot"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iot.NewBillingGroup(ctx, "example", &iot.BillingGroupArgs{
    			Name: pulumi.String("example"),
    			Properties: &iot.BillingGroupPropertiesArgs{
    				Description: pulumi.String("This is my billing group"),
    			},
    			Tags: pulumi.StringMap{
    				"terraform": pulumi.String("true"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Iot.BillingGroup("example", new()
        {
            Name = "example",
            Properties = new Aws.Iot.Inputs.BillingGroupPropertiesArgs
            {
                Description = "This is my billing group",
            },
            Tags = 
            {
                { "terraform", "true" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iot.BillingGroup;
    import com.pulumi.aws.iot.BillingGroupArgs;
    import com.pulumi.aws.iot.inputs.BillingGroupPropertiesArgs;
    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 example = new BillingGroup("example", BillingGroupArgs.builder()
                .name("example")
                .properties(BillingGroupPropertiesArgs.builder()
                    .description("This is my billing group")
                    .build())
                .tags(Map.of("terraform", "true"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:iot:BillingGroup
        properties:
          name: example
          properties:
            description: This is my billing group
          tags:
            terraform: 'true'
    

    Create BillingGroup Resource

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

    Constructor syntax

    new BillingGroup(name: string, args?: BillingGroupArgs, opts?: CustomResourceOptions);
    @overload
    def BillingGroup(resource_name: str,
                     args: Optional[BillingGroupArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BillingGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     name: Optional[str] = None,
                     properties: Optional[BillingGroupPropertiesArgs] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewBillingGroup(ctx *Context, name string, args *BillingGroupArgs, opts ...ResourceOption) (*BillingGroup, error)
    public BillingGroup(string name, BillingGroupArgs? args = null, CustomResourceOptions? opts = null)
    public BillingGroup(String name, BillingGroupArgs args)
    public BillingGroup(String name, BillingGroupArgs args, CustomResourceOptions options)
    
    type: aws:iot:BillingGroup
    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 BillingGroupArgs
    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 BillingGroupArgs
    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 BillingGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BillingGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BillingGroupArgs
    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 billingGroupResource = new Aws.Iot.BillingGroup("billingGroupResource", new()
    {
        Name = "string",
        Properties = new Aws.Iot.Inputs.BillingGroupPropertiesArgs
        {
            Description = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := iot.NewBillingGroup(ctx, "billingGroupResource", &iot.BillingGroupArgs{
    	Name: pulumi.String("string"),
    	Properties: &iot.BillingGroupPropertiesArgs{
    		Description: pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var billingGroupResource = new BillingGroup("billingGroupResource", BillingGroupArgs.builder()
        .name("string")
        .properties(BillingGroupPropertiesArgs.builder()
            .description("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    billing_group_resource = aws.iot.BillingGroup("billingGroupResource",
        name="string",
        properties={
            "description": "string",
        },
        tags={
            "string": "string",
        })
    
    const billingGroupResource = new aws.iot.BillingGroup("billingGroupResource", {
        name: "string",
        properties: {
            description: "string",
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:iot:BillingGroup
    properties:
        name: string
        properties:
            description: string
        tags:
            string: string
    

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

    Name string
    The name of the Billing Group.
    Properties BillingGroupProperties
    The Billing Group properties. Defined below.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags
    Name string
    The name of the Billing Group.
    Properties BillingGroupPropertiesArgs
    The Billing Group properties. Defined below.
    Tags map[string]string
    Key-value mapping of resource tags
    name String
    The name of the Billing Group.
    properties BillingGroupProperties
    The Billing Group properties. Defined below.
    tags Map<String,String>
    Key-value mapping of resource tags
    name string
    The name of the Billing Group.
    properties BillingGroupProperties
    The Billing Group properties. Defined below.
    tags {[key: string]: string}
    Key-value mapping of resource tags
    name str
    The name of the Billing Group.
    properties BillingGroupPropertiesArgs
    The Billing Group properties. Defined below.
    tags Mapping[str, str]
    Key-value mapping of resource tags
    name String
    The name of the Billing Group.
    properties Property Map
    The Billing Group properties. Defined below.
    tags Map<String>
    Key-value mapping of resource tags

    Outputs

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

    Arn string
    The ARN of the Billing Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas List<BillingGroupMetadata>
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Version int
    The current version of the Billing Group record in the registry.
    Arn string
    The ARN of the Billing Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas []BillingGroupMetadata
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Version int
    The current version of the Billing Group record in the registry.
    arn String
    The ARN of the Billing Group.
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<BillingGroupMetadata>
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    version Integer
    The current version of the Billing Group record in the registry.
    arn string
    The ARN of the Billing Group.
    id string
    The provider-assigned unique ID for this managed resource.
    metadatas BillingGroupMetadata[]
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    version number
    The current version of the Billing Group record in the registry.
    arn str
    The ARN of the Billing Group.
    id str
    The provider-assigned unique ID for this managed resource.
    metadatas Sequence[BillingGroupMetadata]
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    version int
    The current version of the Billing Group record in the registry.
    arn String
    The ARN of the Billing Group.
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<Property Map>
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    version Number
    The current version of the Billing Group record in the registry.

    Look up Existing BillingGroup Resource

    Get an existing BillingGroup 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?: BillingGroupState, opts?: CustomResourceOptions): BillingGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            metadatas: Optional[Sequence[BillingGroupMetadataArgs]] = None,
            name: Optional[str] = None,
            properties: Optional[BillingGroupPropertiesArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            version: Optional[int] = None) -> BillingGroup
    func GetBillingGroup(ctx *Context, name string, id IDInput, state *BillingGroupState, opts ...ResourceOption) (*BillingGroup, error)
    public static BillingGroup Get(string name, Input<string> id, BillingGroupState? state, CustomResourceOptions? opts = null)
    public static BillingGroup get(String name, Output<String> id, BillingGroupState 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:
    Arn string
    The ARN of the Billing Group.
    Metadatas List<BillingGroupMetadata>
    Name string
    The name of the Billing Group.
    Properties BillingGroupProperties
    The Billing Group properties. Defined below.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Version int
    The current version of the Billing Group record in the registry.
    Arn string
    The ARN of the Billing Group.
    Metadatas []BillingGroupMetadataArgs
    Name string
    The name of the Billing Group.
    Properties BillingGroupPropertiesArgs
    The Billing Group properties. Defined below.
    Tags map[string]string
    Key-value mapping of resource tags
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Version int
    The current version of the Billing Group record in the registry.
    arn String
    The ARN of the Billing Group.
    metadatas List<BillingGroupMetadata>
    name String
    The name of the Billing Group.
    properties BillingGroupProperties
    The Billing Group properties. Defined below.
    tags Map<String,String>
    Key-value mapping of resource tags
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    version Integer
    The current version of the Billing Group record in the registry.
    arn string
    The ARN of the Billing Group.
    metadatas BillingGroupMetadata[]
    name string
    The name of the Billing Group.
    properties BillingGroupProperties
    The Billing Group properties. Defined below.
    tags {[key: string]: string}
    Key-value mapping of resource tags
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    version number
    The current version of the Billing Group record in the registry.
    arn str
    The ARN of the Billing Group.
    metadatas Sequence[BillingGroupMetadataArgs]
    name str
    The name of the Billing Group.
    properties BillingGroupPropertiesArgs
    The Billing Group properties. Defined below.
    tags Mapping[str, str]
    Key-value mapping of resource tags
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    version int
    The current version of the Billing Group record in the registry.
    arn String
    The ARN of the Billing Group.
    metadatas List<Property Map>
    name String
    The name of the Billing Group.
    properties Property Map
    The Billing Group properties. Defined below.
    tags Map<String>
    Key-value mapping of resource tags
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    version Number
    The current version of the Billing Group record in the registry.

    Supporting Types

    BillingGroupMetadata, BillingGroupMetadataArgs

    BillingGroupProperties, BillingGroupPropertiesArgs

    Description string
    A description of the Billing Group.
    Description string
    A description of the Billing Group.
    description String
    A description of the Billing Group.
    description string
    A description of the Billing Group.
    description str
    A description of the Billing Group.
    description String
    A description of the Billing Group.

    Import

    Using pulumi import, import IoT Billing Groups using the name. For example:

    $ pulumi import aws:iot/billingGroup:BillingGroup example example
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi