resourcegroups

package
v3.38.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Group

type Group struct {
	pulumi.CustomResourceState

	// The ARN assigned by AWS for this resource group.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// A description of the resource group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`.
	Name pulumi.StringOutput `pulumi:"name"`
	// A `resourceQuery` block. Resource queries are documented below.
	ResourceQuery GroupResourceQueryOutput `pulumi:"resourceQuery"`
	// Key-value map of resource tags
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides a Resource Group.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/resourcegroups"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroups.NewGroup(ctx, "test", &resourcegroups.GroupArgs{
			ResourceQuery: &resourcegroups.GroupResourceQueryArgs{
				Query: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"ResourceTypeFilters\": [\n", "    \"AWS::EC2::Instance\"\n", "  ],\n", "  \"TagFilters\": [\n", "    {\n", "      \"Key\": \"Stage\",\n", "      \"Values\": [\"Test\"]\n", "    }\n", "  ]\n", "}\n", "\n")),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Resource groups can be imported using the `name`, e.g.

```sh

$ pulumi import aws:resourcegroups/group:Group foo resource-group-name

```

func GetGroup

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType added in v3.13.0

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput added in v3.13.0

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext added in v3.13.0

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

func (*Group) ToGroupPtrOutput added in v3.25.0

func (i *Group) ToGroupPtrOutput() GroupPtrOutput

func (*Group) ToGroupPtrOutputWithContext added in v3.25.0

func (i *Group) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

type GroupArgs

type GroupArgs struct {
	// A description of the resource group.
	Description pulumi.StringPtrInput
	// The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`.
	Name pulumi.StringPtrInput
	// A `resourceQuery` block. Resource queries are documented below.
	ResourceQuery GroupResourceQueryInput
	// Key-value map of resource tags
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType

func (GroupArgs) ElementType() reflect.Type

type GroupArray added in v3.25.0

type GroupArray []GroupInput

func (GroupArray) ElementType added in v3.25.0

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput added in v3.25.0

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext added in v3.25.0

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput added in v3.25.0

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:

GroupArray{ GroupArgs{...} }

type GroupArrayOutput added in v3.25.0

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType added in v3.25.0

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index added in v3.25.0

func (GroupArrayOutput) ToGroupArrayOutput added in v3.25.0

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext added in v3.25.0

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupInput added in v3.13.0

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap added in v3.25.0

type GroupMap map[string]GroupInput

func (GroupMap) ElementType added in v3.25.0

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput added in v3.25.0

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext added in v3.25.0

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput added in v3.25.0

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput added in v3.25.0

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType added in v3.25.0

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex added in v3.25.0

func (GroupMapOutput) ToGroupMapOutput added in v3.25.0

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext added in v3.25.0

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput added in v3.13.0

type GroupOutput struct {
	*pulumi.OutputState
}

func (GroupOutput) ElementType added in v3.13.0

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) ToGroupOutput added in v3.13.0

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext added in v3.13.0

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

func (GroupOutput) ToGroupPtrOutput added in v3.25.0

func (o GroupOutput) ToGroupPtrOutput() GroupPtrOutput

func (GroupOutput) ToGroupPtrOutputWithContext added in v3.25.0

func (o GroupOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

type GroupPtrInput added in v3.25.0

type GroupPtrInput interface {
	pulumi.Input

	ToGroupPtrOutput() GroupPtrOutput
	ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
}

type GroupPtrOutput added in v3.25.0

type GroupPtrOutput struct {
	*pulumi.OutputState
}

func (GroupPtrOutput) ElementType added in v3.25.0

func (GroupPtrOutput) ElementType() reflect.Type

func (GroupPtrOutput) ToGroupPtrOutput added in v3.25.0

func (o GroupPtrOutput) ToGroupPtrOutput() GroupPtrOutput

func (GroupPtrOutput) ToGroupPtrOutputWithContext added in v3.25.0

func (o GroupPtrOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

type GroupResourceQuery

type GroupResourceQuery struct {
	// The resource query as a JSON string.
	Query string `pulumi:"query"`
	// The type of the resource query. Defaults to `TAG_FILTERS_1_0`.
	Type *string `pulumi:"type"`
}

type GroupResourceQueryArgs

type GroupResourceQueryArgs struct {
	// The resource query as a JSON string.
	Query pulumi.StringInput `pulumi:"query"`
	// The type of the resource query. Defaults to `TAG_FILTERS_1_0`.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

func (GroupResourceQueryArgs) ElementType

func (GroupResourceQueryArgs) ElementType() reflect.Type

func (GroupResourceQueryArgs) ToGroupResourceQueryOutput

func (i GroupResourceQueryArgs) ToGroupResourceQueryOutput() GroupResourceQueryOutput

func (GroupResourceQueryArgs) ToGroupResourceQueryOutputWithContext

func (i GroupResourceQueryArgs) ToGroupResourceQueryOutputWithContext(ctx context.Context) GroupResourceQueryOutput

func (GroupResourceQueryArgs) ToGroupResourceQueryPtrOutput

func (i GroupResourceQueryArgs) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput

func (GroupResourceQueryArgs) ToGroupResourceQueryPtrOutputWithContext

func (i GroupResourceQueryArgs) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput

type GroupResourceQueryInput

type GroupResourceQueryInput interface {
	pulumi.Input

	ToGroupResourceQueryOutput() GroupResourceQueryOutput
	ToGroupResourceQueryOutputWithContext(context.Context) GroupResourceQueryOutput
}

GroupResourceQueryInput is an input type that accepts GroupResourceQueryArgs and GroupResourceQueryOutput values. You can construct a concrete instance of `GroupResourceQueryInput` via:

GroupResourceQueryArgs{...}

type GroupResourceQueryOutput

type GroupResourceQueryOutput struct{ *pulumi.OutputState }

func (GroupResourceQueryOutput) ElementType

func (GroupResourceQueryOutput) ElementType() reflect.Type

func (GroupResourceQueryOutput) Query

The resource query as a JSON string.

func (GroupResourceQueryOutput) ToGroupResourceQueryOutput

func (o GroupResourceQueryOutput) ToGroupResourceQueryOutput() GroupResourceQueryOutput

func (GroupResourceQueryOutput) ToGroupResourceQueryOutputWithContext

func (o GroupResourceQueryOutput) ToGroupResourceQueryOutputWithContext(ctx context.Context) GroupResourceQueryOutput

func (GroupResourceQueryOutput) ToGroupResourceQueryPtrOutput

func (o GroupResourceQueryOutput) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput

func (GroupResourceQueryOutput) ToGroupResourceQueryPtrOutputWithContext

func (o GroupResourceQueryOutput) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput

func (GroupResourceQueryOutput) Type

The type of the resource query. Defaults to `TAG_FILTERS_1_0`.

type GroupResourceQueryPtrInput

type GroupResourceQueryPtrInput interface {
	pulumi.Input

	ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput
	ToGroupResourceQueryPtrOutputWithContext(context.Context) GroupResourceQueryPtrOutput
}

GroupResourceQueryPtrInput is an input type that accepts GroupResourceQueryArgs, GroupResourceQueryPtr and GroupResourceQueryPtrOutput values. You can construct a concrete instance of `GroupResourceQueryPtrInput` via:

        GroupResourceQueryArgs{...}

or:

        nil

type GroupResourceQueryPtrOutput

type GroupResourceQueryPtrOutput struct{ *pulumi.OutputState }

func (GroupResourceQueryPtrOutput) Elem

func (GroupResourceQueryPtrOutput) ElementType

func (GroupResourceQueryPtrOutput) Query

The resource query as a JSON string.

func (GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutput

func (o GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput

func (GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutputWithContext

func (o GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput

func (GroupResourceQueryPtrOutput) Type

The type of the resource query. Defaults to `TAG_FILTERS_1_0`.

type GroupState

type GroupState struct {
	// The ARN assigned by AWS for this resource group.
	Arn pulumi.StringPtrInput
	// A description of the resource group.
	Description pulumi.StringPtrInput
	// The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`.
	Name pulumi.StringPtrInput
	// A `resourceQuery` block. Resource queries are documented below.
	ResourceQuery GroupResourceQueryPtrInput
	// Key-value map of resource tags
	Tags pulumi.StringMapInput
}

func (GroupState) ElementType

func (GroupState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL