Documentation
¶
Index ¶
- type Group
- type GroupArgs
- type GroupArray
- type GroupArrayInput
- type GroupArrayOutput
- type GroupInput
- type GroupMap
- type GroupMapInput
- type GroupMapOutput
- type GroupOutput
- type GroupResourceQuery
- type GroupResourceQueryArgs
- func (GroupResourceQueryArgs) ElementType() reflect.Type
- func (i GroupResourceQueryArgs) ToGroupResourceQueryOutput() GroupResourceQueryOutput
- func (i GroupResourceQueryArgs) ToGroupResourceQueryOutputWithContext(ctx context.Context) GroupResourceQueryOutput
- func (i GroupResourceQueryArgs) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput
- func (i GroupResourceQueryArgs) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput
- type GroupResourceQueryInput
- type GroupResourceQueryOutput
- func (GroupResourceQueryOutput) ElementType() reflect.Type
- func (o GroupResourceQueryOutput) Query() pulumi.StringOutput
- func (o GroupResourceQueryOutput) ToGroupResourceQueryOutput() GroupResourceQueryOutput
- func (o GroupResourceQueryOutput) ToGroupResourceQueryOutputWithContext(ctx context.Context) GroupResourceQueryOutput
- func (o GroupResourceQueryOutput) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput
- func (o GroupResourceQueryOutput) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput
- func (o GroupResourceQueryOutput) Type() pulumi.StringPtrOutput
- type GroupResourceQueryPtrInput
- type GroupResourceQueryPtrOutput
- func (o GroupResourceQueryPtrOutput) Elem() GroupResourceQueryOutput
- func (GroupResourceQueryPtrOutput) ElementType() reflect.Type
- func (o GroupResourceQueryPtrOutput) Query() pulumi.StringPtrOutput
- func (o GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutput() GroupResourceQueryPtrOutput
- func (o GroupResourceQueryPtrOutput) ToGroupResourceQueryPtrOutputWithContext(ctx context.Context) GroupResourceQueryPtrOutput
- func (o GroupResourceQueryPtrOutput) Type() pulumi.StringPtrOutput
- type GroupState
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. .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 .
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}
Provides a Resource Group.
## Example Usage
```go package main
import (
"fmt" "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(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 ¶
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 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. .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 ¶
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 (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput
func (GroupArrayOutput) ToGroupArrayOutput ¶
func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput
func (GroupArrayOutput) ToGroupArrayOutputWithContext ¶
func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
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) 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 (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput
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) ElementType ¶
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) ToGroupOutput ¶
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
type GroupResourceQuery ¶
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 ¶
func (o GroupResourceQueryOutput) Query() pulumi.StringOutput
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 ¶
func (o GroupResourceQueryOutput) Type() pulumi.StringPtrOutput
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
func GroupResourceQueryPtr ¶
func GroupResourceQueryPtr(v *GroupResourceQueryArgs) GroupResourceQueryPtrInput
type GroupResourceQueryPtrOutput ¶
type GroupResourceQueryPtrOutput struct{ *pulumi.OutputState }
func (GroupResourceQueryPtrOutput) Elem ¶
func (o GroupResourceQueryPtrOutput) Elem() GroupResourceQueryOutput
func (GroupResourceQueryPtrOutput) ElementType ¶
func (GroupResourceQueryPtrOutput) ElementType() reflect.Type
func (GroupResourceQueryPtrOutput) Query ¶
func (o GroupResourceQueryPtrOutput) Query() pulumi.StringPtrOutput
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 ¶
func (o GroupResourceQueryPtrOutput) Type() pulumi.StringPtrOutput
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. .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 .
TagsAll pulumi.StringMapInput
}
func (GroupState) ElementType ¶
func (GroupState) ElementType() reflect.Type