resourcegroups

package
v5.43.0 Latest Latest
Warning

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

Go to latest
Published: Nov 21, 2023 License: Apache-2.0 Imports: 6 Imported by: 2

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 configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details.
	Configurations GroupConfigurationArrayOutput `pulumi:"configurations"`
	// 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 GroupResourceQueryPtrOutput `pulumi:"resourceQuery"`
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides a Resource Group.

## Example Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroups.NewGroup(ctx, "test", &resourcegroups.GroupArgs{
			ResourceQuery: &resourcegroups.GroupResourceQueryArgs{
				Query: pulumi.String(`{
  "ResourceTypeFilters": [
    "AWS::EC2::Instance"
  ],
  "TagFilters": [
    {
      "Key": "Stage",
      "Values": ["Test"]
    }
  ]
}

`),

			},
		})
		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

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext

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

type GroupArgs

type GroupArgs struct {
	// A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details.
	Configurations GroupConfigurationArrayInput
	// 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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType

func (GroupArgs) ElementType() reflect.Type

type GroupArray

type GroupArray []GroupInput

func (GroupArray) ElementType

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext

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

type GroupArrayInput

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

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index

func (GroupArrayOutput) ToGroupArrayOutput

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext

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

type GroupConfiguration added in v5.19.0

type GroupConfiguration struct {
	// A collection of parameters for this group configuration item. See below for details.
	Parameters []GroupConfigurationParameter `pulumi:"parameters"`
	// Specifies the type of group configuration item.
	Type string `pulumi:"type"`
}

type GroupConfigurationArgs added in v5.19.0

type GroupConfigurationArgs struct {
	// A collection of parameters for this group configuration item. See below for details.
	Parameters GroupConfigurationParameterArrayInput `pulumi:"parameters"`
	// Specifies the type of group configuration item.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GroupConfigurationArgs) ElementType added in v5.19.0

func (GroupConfigurationArgs) ElementType() reflect.Type

func (GroupConfigurationArgs) ToGroupConfigurationOutput added in v5.19.0

func (i GroupConfigurationArgs) ToGroupConfigurationOutput() GroupConfigurationOutput

func (GroupConfigurationArgs) ToGroupConfigurationOutputWithContext added in v5.19.0

func (i GroupConfigurationArgs) ToGroupConfigurationOutputWithContext(ctx context.Context) GroupConfigurationOutput

type GroupConfigurationArray added in v5.19.0

type GroupConfigurationArray []GroupConfigurationInput

func (GroupConfigurationArray) ElementType added in v5.19.0

func (GroupConfigurationArray) ElementType() reflect.Type

func (GroupConfigurationArray) ToGroupConfigurationArrayOutput added in v5.19.0

func (i GroupConfigurationArray) ToGroupConfigurationArrayOutput() GroupConfigurationArrayOutput

func (GroupConfigurationArray) ToGroupConfigurationArrayOutputWithContext added in v5.19.0

func (i GroupConfigurationArray) ToGroupConfigurationArrayOutputWithContext(ctx context.Context) GroupConfigurationArrayOutput

type GroupConfigurationArrayInput added in v5.19.0

type GroupConfigurationArrayInput interface {
	pulumi.Input

	ToGroupConfigurationArrayOutput() GroupConfigurationArrayOutput
	ToGroupConfigurationArrayOutputWithContext(context.Context) GroupConfigurationArrayOutput
}

GroupConfigurationArrayInput is an input type that accepts GroupConfigurationArray and GroupConfigurationArrayOutput values. You can construct a concrete instance of `GroupConfigurationArrayInput` via:

GroupConfigurationArray{ GroupConfigurationArgs{...} }

type GroupConfigurationArrayOutput added in v5.19.0

type GroupConfigurationArrayOutput struct{ *pulumi.OutputState }

func (GroupConfigurationArrayOutput) ElementType added in v5.19.0

func (GroupConfigurationArrayOutput) Index added in v5.19.0

func (GroupConfigurationArrayOutput) ToGroupConfigurationArrayOutput added in v5.19.0

func (o GroupConfigurationArrayOutput) ToGroupConfigurationArrayOutput() GroupConfigurationArrayOutput

func (GroupConfigurationArrayOutput) ToGroupConfigurationArrayOutputWithContext added in v5.19.0

func (o GroupConfigurationArrayOutput) ToGroupConfigurationArrayOutputWithContext(ctx context.Context) GroupConfigurationArrayOutput

type GroupConfigurationInput added in v5.19.0

type GroupConfigurationInput interface {
	pulumi.Input

	ToGroupConfigurationOutput() GroupConfigurationOutput
	ToGroupConfigurationOutputWithContext(context.Context) GroupConfigurationOutput
}

GroupConfigurationInput is an input type that accepts GroupConfigurationArgs and GroupConfigurationOutput values. You can construct a concrete instance of `GroupConfigurationInput` via:

GroupConfigurationArgs{...}

type GroupConfigurationOutput added in v5.19.0

type GroupConfigurationOutput struct{ *pulumi.OutputState }

func (GroupConfigurationOutput) ElementType added in v5.19.0

func (GroupConfigurationOutput) ElementType() reflect.Type

func (GroupConfigurationOutput) Parameters added in v5.19.0

A collection of parameters for this group configuration item. See below for details.

func (GroupConfigurationOutput) ToGroupConfigurationOutput added in v5.19.0

func (o GroupConfigurationOutput) ToGroupConfigurationOutput() GroupConfigurationOutput

func (GroupConfigurationOutput) ToGroupConfigurationOutputWithContext added in v5.19.0

func (o GroupConfigurationOutput) ToGroupConfigurationOutputWithContext(ctx context.Context) GroupConfigurationOutput

func (GroupConfigurationOutput) Type added in v5.19.0

Specifies the type of group configuration item.

type GroupConfigurationParameter added in v5.19.0

type GroupConfigurationParameter struct {
	// The name of the group configuration parameter.
	Name string `pulumi:"name"`
	// The value or values to be used for the specified parameter.
	Values []string `pulumi:"values"`
}

type GroupConfigurationParameterArgs added in v5.19.0

type GroupConfigurationParameterArgs struct {
	// The name of the group configuration parameter.
	Name pulumi.StringInput `pulumi:"name"`
	// The value or values to be used for the specified parameter.
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GroupConfigurationParameterArgs) ElementType added in v5.19.0

func (GroupConfigurationParameterArgs) ToGroupConfigurationParameterOutput added in v5.19.0

func (i GroupConfigurationParameterArgs) ToGroupConfigurationParameterOutput() GroupConfigurationParameterOutput

func (GroupConfigurationParameterArgs) ToGroupConfigurationParameterOutputWithContext added in v5.19.0

func (i GroupConfigurationParameterArgs) ToGroupConfigurationParameterOutputWithContext(ctx context.Context) GroupConfigurationParameterOutput

type GroupConfigurationParameterArray added in v5.19.0

type GroupConfigurationParameterArray []GroupConfigurationParameterInput

func (GroupConfigurationParameterArray) ElementType added in v5.19.0

func (GroupConfigurationParameterArray) ToGroupConfigurationParameterArrayOutput added in v5.19.0

func (i GroupConfigurationParameterArray) ToGroupConfigurationParameterArrayOutput() GroupConfigurationParameterArrayOutput

func (GroupConfigurationParameterArray) ToGroupConfigurationParameterArrayOutputWithContext added in v5.19.0

func (i GroupConfigurationParameterArray) ToGroupConfigurationParameterArrayOutputWithContext(ctx context.Context) GroupConfigurationParameterArrayOutput

type GroupConfigurationParameterArrayInput added in v5.19.0

type GroupConfigurationParameterArrayInput interface {
	pulumi.Input

	ToGroupConfigurationParameterArrayOutput() GroupConfigurationParameterArrayOutput
	ToGroupConfigurationParameterArrayOutputWithContext(context.Context) GroupConfigurationParameterArrayOutput
}

GroupConfigurationParameterArrayInput is an input type that accepts GroupConfigurationParameterArray and GroupConfigurationParameterArrayOutput values. You can construct a concrete instance of `GroupConfigurationParameterArrayInput` via:

GroupConfigurationParameterArray{ GroupConfigurationParameterArgs{...} }

type GroupConfigurationParameterArrayOutput added in v5.19.0

type GroupConfigurationParameterArrayOutput struct{ *pulumi.OutputState }

func (GroupConfigurationParameterArrayOutput) ElementType added in v5.19.0

func (GroupConfigurationParameterArrayOutput) Index added in v5.19.0

func (GroupConfigurationParameterArrayOutput) ToGroupConfigurationParameterArrayOutput added in v5.19.0

func (o GroupConfigurationParameterArrayOutput) ToGroupConfigurationParameterArrayOutput() GroupConfigurationParameterArrayOutput

func (GroupConfigurationParameterArrayOutput) ToGroupConfigurationParameterArrayOutputWithContext added in v5.19.0

func (o GroupConfigurationParameterArrayOutput) ToGroupConfigurationParameterArrayOutputWithContext(ctx context.Context) GroupConfigurationParameterArrayOutput

type GroupConfigurationParameterInput added in v5.19.0

type GroupConfigurationParameterInput interface {
	pulumi.Input

	ToGroupConfigurationParameterOutput() GroupConfigurationParameterOutput
	ToGroupConfigurationParameterOutputWithContext(context.Context) GroupConfigurationParameterOutput
}

GroupConfigurationParameterInput is an input type that accepts GroupConfigurationParameterArgs and GroupConfigurationParameterOutput values. You can construct a concrete instance of `GroupConfigurationParameterInput` via:

GroupConfigurationParameterArgs{...}

type GroupConfigurationParameterOutput added in v5.19.0

type GroupConfigurationParameterOutput struct{ *pulumi.OutputState }

func (GroupConfigurationParameterOutput) ElementType added in v5.19.0

func (GroupConfigurationParameterOutput) Name added in v5.19.0

The name of the group configuration parameter.

func (GroupConfigurationParameterOutput) ToGroupConfigurationParameterOutput added in v5.19.0

func (o GroupConfigurationParameterOutput) ToGroupConfigurationParameterOutput() GroupConfigurationParameterOutput

func (GroupConfigurationParameterOutput) ToGroupConfigurationParameterOutputWithContext added in v5.19.0

func (o GroupConfigurationParameterOutput) ToGroupConfigurationParameterOutputWithContext(ctx context.Context) GroupConfigurationParameterOutput

func (GroupConfigurationParameterOutput) Values added in v5.19.0

The value or values to be used for the specified parameter.

type GroupInput

type GroupInput interface {
	pulumi.Input

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

type GroupMap

type GroupMap map[string]GroupInput

func (GroupMap) ElementType

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext

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

type GroupMapInput

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

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex

func (GroupMapOutput) ToGroupMapOutput

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext

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

type GroupOutput

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) Arn added in v5.4.0

The ARN assigned by AWS for this resource group.

func (GroupOutput) Configurations added in v5.19.0

func (o GroupOutput) Configurations() GroupConfigurationArrayOutput

A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details.

func (GroupOutput) Description added in v5.4.0

func (o GroupOutput) Description() pulumi.StringPtrOutput

A description of the resource group.

func (GroupOutput) ElementType

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name added in v5.4.0

func (o GroupOutput) Name() pulumi.StringOutput

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`.

func (GroupOutput) ResourceQuery added in v5.4.0

func (o GroupOutput) ResourceQuery() GroupResourceQueryPtrOutput

A `resourceQuery` block. Resource queries are documented below.

func (GroupOutput) Tags added in v5.4.0

Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (GroupOutput) TagsAll added in v5.4.0

func (o GroupOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (GroupOutput) ToGroupOutput

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext

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

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 configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details.
	Configurations GroupConfigurationArrayInput
	// 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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll 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