resourcegroupstaggingapi

package
v6.59.0 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetResourcesArgs

type GetResourcesArgs struct {
	// Specifies whether to exclude resources that are compliant with the tag policy. You can use this parameter only if the `includeComplianceDetails` argument is also set to `true`.
	ExcludeCompliantResources *bool `pulumi:"excludeCompliantResources"`
	// Specifies whether to include details regarding the compliance with the effective tag policy.
	IncludeComplianceDetails *bool `pulumi:"includeComplianceDetails"`
	// Specifies a list of ARNs of resources for which you want to retrieve tag data. Conflicts with `filter`.
	ResourceArnLists []string `pulumi:"resourceArnLists"`
	// Constraints on the resources that you want returned. The format of each resource type is `service:resourceType`. For example, specifying a resource type of `ec2` returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of `ec2:instance` returns only EC2 instances.
	ResourceTypeFilters []string `pulumi:"resourceTypeFilters"`
	// Specifies a list of Tag Filters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. See Tag Filter below. Conflicts with `resourceArnList`.
	TagFilters []GetResourcesTagFilter `pulumi:"tagFilters"`
}

A collection of arguments for invoking getResources.

type GetResourcesOutputArgs

type GetResourcesOutputArgs struct {
	// Specifies whether to exclude resources that are compliant with the tag policy. You can use this parameter only if the `includeComplianceDetails` argument is also set to `true`.
	ExcludeCompliantResources pulumi.BoolPtrInput `pulumi:"excludeCompliantResources"`
	// Specifies whether to include details regarding the compliance with the effective tag policy.
	IncludeComplianceDetails pulumi.BoolPtrInput `pulumi:"includeComplianceDetails"`
	// Specifies a list of ARNs of resources for which you want to retrieve tag data. Conflicts with `filter`.
	ResourceArnLists pulumi.StringArrayInput `pulumi:"resourceArnLists"`
	// Constraints on the resources that you want returned. The format of each resource type is `service:resourceType`. For example, specifying a resource type of `ec2` returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of `ec2:instance` returns only EC2 instances.
	ResourceTypeFilters pulumi.StringArrayInput `pulumi:"resourceTypeFilters"`
	// Specifies a list of Tag Filters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. See Tag Filter below. Conflicts with `resourceArnList`.
	TagFilters GetResourcesTagFilterArrayInput `pulumi:"tagFilters"`
}

A collection of arguments for invoking getResources.

func (GetResourcesOutputArgs) ElementType

func (GetResourcesOutputArgs) ElementType() reflect.Type

type GetResourcesResourceTagMappingList

type GetResourcesResourceTagMappingList struct {
	// List of objects with information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
	ComplianceDetails []GetResourcesResourceTagMappingListComplianceDetail `pulumi:"complianceDetails"`
	// ARN of the resource.
	ResourceArn string `pulumi:"resourceArn"`
	// Map of tags assigned to the resource.
	Tags map[string]string `pulumi:"tags"`
}

type GetResourcesResourceTagMappingListArgs

type GetResourcesResourceTagMappingListArgs struct {
	// List of objects with information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
	ComplianceDetails GetResourcesResourceTagMappingListComplianceDetailArrayInput `pulumi:"complianceDetails"`
	// ARN of the resource.
	ResourceArn pulumi.StringInput `pulumi:"resourceArn"`
	// Map of tags assigned to the resource.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (GetResourcesResourceTagMappingListArgs) ElementType

func (GetResourcesResourceTagMappingListArgs) ToGetResourcesResourceTagMappingListOutput

func (i GetResourcesResourceTagMappingListArgs) ToGetResourcesResourceTagMappingListOutput() GetResourcesResourceTagMappingListOutput

func (GetResourcesResourceTagMappingListArgs) ToGetResourcesResourceTagMappingListOutputWithContext

func (i GetResourcesResourceTagMappingListArgs) ToGetResourcesResourceTagMappingListOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListOutput

type GetResourcesResourceTagMappingListArray

type GetResourcesResourceTagMappingListArray []GetResourcesResourceTagMappingListInput

func (GetResourcesResourceTagMappingListArray) ElementType

func (GetResourcesResourceTagMappingListArray) ToGetResourcesResourceTagMappingListArrayOutput

func (i GetResourcesResourceTagMappingListArray) ToGetResourcesResourceTagMappingListArrayOutput() GetResourcesResourceTagMappingListArrayOutput

func (GetResourcesResourceTagMappingListArray) ToGetResourcesResourceTagMappingListArrayOutputWithContext

func (i GetResourcesResourceTagMappingListArray) ToGetResourcesResourceTagMappingListArrayOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListArrayOutput

type GetResourcesResourceTagMappingListArrayInput

type GetResourcesResourceTagMappingListArrayInput interface {
	pulumi.Input

	ToGetResourcesResourceTagMappingListArrayOutput() GetResourcesResourceTagMappingListArrayOutput
	ToGetResourcesResourceTagMappingListArrayOutputWithContext(context.Context) GetResourcesResourceTagMappingListArrayOutput
}

GetResourcesResourceTagMappingListArrayInput is an input type that accepts GetResourcesResourceTagMappingListArray and GetResourcesResourceTagMappingListArrayOutput values. You can construct a concrete instance of `GetResourcesResourceTagMappingListArrayInput` via:

GetResourcesResourceTagMappingListArray{ GetResourcesResourceTagMappingListArgs{...} }

type GetResourcesResourceTagMappingListArrayOutput

type GetResourcesResourceTagMappingListArrayOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceTagMappingListArrayOutput) ElementType

func (GetResourcesResourceTagMappingListArrayOutput) Index

func (GetResourcesResourceTagMappingListArrayOutput) ToGetResourcesResourceTagMappingListArrayOutput

func (o GetResourcesResourceTagMappingListArrayOutput) ToGetResourcesResourceTagMappingListArrayOutput() GetResourcesResourceTagMappingListArrayOutput

func (GetResourcesResourceTagMappingListArrayOutput) ToGetResourcesResourceTagMappingListArrayOutputWithContext

func (o GetResourcesResourceTagMappingListArrayOutput) ToGetResourcesResourceTagMappingListArrayOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListArrayOutput

type GetResourcesResourceTagMappingListComplianceDetail

type GetResourcesResourceTagMappingListComplianceDetail struct {
	// Whether the resource is compliant.
	// * ` keysWithNoncompliantValues  ` - Set of tag keys with non-compliant tag values.
	// * ` nonCompliantKeys  ` - Set of non-compliant tag keys.
	ComplianceStatus           bool     `pulumi:"complianceStatus"`
	KeysWithNoncompliantValues []string `pulumi:"keysWithNoncompliantValues"`
	NonCompliantKeys           []string `pulumi:"nonCompliantKeys"`
}

type GetResourcesResourceTagMappingListComplianceDetailArgs

type GetResourcesResourceTagMappingListComplianceDetailArgs struct {
	// Whether the resource is compliant.
	// * ` keysWithNoncompliantValues  ` - Set of tag keys with non-compliant tag values.
	// * ` nonCompliantKeys  ` - Set of non-compliant tag keys.
	ComplianceStatus           pulumi.BoolInput        `pulumi:"complianceStatus"`
	KeysWithNoncompliantValues pulumi.StringArrayInput `pulumi:"keysWithNoncompliantValues"`
	NonCompliantKeys           pulumi.StringArrayInput `pulumi:"nonCompliantKeys"`
}

func (GetResourcesResourceTagMappingListComplianceDetailArgs) ElementType

func (GetResourcesResourceTagMappingListComplianceDetailArgs) ToGetResourcesResourceTagMappingListComplianceDetailOutput

func (GetResourcesResourceTagMappingListComplianceDetailArgs) ToGetResourcesResourceTagMappingListComplianceDetailOutputWithContext

func (i GetResourcesResourceTagMappingListComplianceDetailArgs) ToGetResourcesResourceTagMappingListComplianceDetailOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListComplianceDetailOutput

type GetResourcesResourceTagMappingListComplianceDetailArray

type GetResourcesResourceTagMappingListComplianceDetailArray []GetResourcesResourceTagMappingListComplianceDetailInput

func (GetResourcesResourceTagMappingListComplianceDetailArray) ElementType

func (GetResourcesResourceTagMappingListComplianceDetailArray) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutput

func (i GetResourcesResourceTagMappingListComplianceDetailArray) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutput() GetResourcesResourceTagMappingListComplianceDetailArrayOutput

func (GetResourcesResourceTagMappingListComplianceDetailArray) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutputWithContext

func (i GetResourcesResourceTagMappingListComplianceDetailArray) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListComplianceDetailArrayOutput

type GetResourcesResourceTagMappingListComplianceDetailArrayInput

type GetResourcesResourceTagMappingListComplianceDetailArrayInput interface {
	pulumi.Input

	ToGetResourcesResourceTagMappingListComplianceDetailArrayOutput() GetResourcesResourceTagMappingListComplianceDetailArrayOutput
	ToGetResourcesResourceTagMappingListComplianceDetailArrayOutputWithContext(context.Context) GetResourcesResourceTagMappingListComplianceDetailArrayOutput
}

GetResourcesResourceTagMappingListComplianceDetailArrayInput is an input type that accepts GetResourcesResourceTagMappingListComplianceDetailArray and GetResourcesResourceTagMappingListComplianceDetailArrayOutput values. You can construct a concrete instance of `GetResourcesResourceTagMappingListComplianceDetailArrayInput` via:

GetResourcesResourceTagMappingListComplianceDetailArray{ GetResourcesResourceTagMappingListComplianceDetailArgs{...} }

type GetResourcesResourceTagMappingListComplianceDetailArrayOutput

type GetResourcesResourceTagMappingListComplianceDetailArrayOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceTagMappingListComplianceDetailArrayOutput) ElementType

func (GetResourcesResourceTagMappingListComplianceDetailArrayOutput) Index

func (GetResourcesResourceTagMappingListComplianceDetailArrayOutput) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutput

func (GetResourcesResourceTagMappingListComplianceDetailArrayOutput) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutputWithContext

func (o GetResourcesResourceTagMappingListComplianceDetailArrayOutput) ToGetResourcesResourceTagMappingListComplianceDetailArrayOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListComplianceDetailArrayOutput

type GetResourcesResourceTagMappingListComplianceDetailInput

type GetResourcesResourceTagMappingListComplianceDetailInput interface {
	pulumi.Input

	ToGetResourcesResourceTagMappingListComplianceDetailOutput() GetResourcesResourceTagMappingListComplianceDetailOutput
	ToGetResourcesResourceTagMappingListComplianceDetailOutputWithContext(context.Context) GetResourcesResourceTagMappingListComplianceDetailOutput
}

GetResourcesResourceTagMappingListComplianceDetailInput is an input type that accepts GetResourcesResourceTagMappingListComplianceDetailArgs and GetResourcesResourceTagMappingListComplianceDetailOutput values. You can construct a concrete instance of `GetResourcesResourceTagMappingListComplianceDetailInput` via:

GetResourcesResourceTagMappingListComplianceDetailArgs{...}

type GetResourcesResourceTagMappingListComplianceDetailOutput

type GetResourcesResourceTagMappingListComplianceDetailOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceTagMappingListComplianceDetailOutput) ComplianceStatus

Whether the resource is compliant. * ` keysWithNoncompliantValues ` - Set of tag keys with non-compliant tag values. * ` nonCompliantKeys ` - Set of non-compliant tag keys.

func (GetResourcesResourceTagMappingListComplianceDetailOutput) ElementType

func (GetResourcesResourceTagMappingListComplianceDetailOutput) KeysWithNoncompliantValues

func (GetResourcesResourceTagMappingListComplianceDetailOutput) NonCompliantKeys

func (GetResourcesResourceTagMappingListComplianceDetailOutput) ToGetResourcesResourceTagMappingListComplianceDetailOutput

func (GetResourcesResourceTagMappingListComplianceDetailOutput) ToGetResourcesResourceTagMappingListComplianceDetailOutputWithContext

func (o GetResourcesResourceTagMappingListComplianceDetailOutput) ToGetResourcesResourceTagMappingListComplianceDetailOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListComplianceDetailOutput

type GetResourcesResourceTagMappingListInput

type GetResourcesResourceTagMappingListInput interface {
	pulumi.Input

	ToGetResourcesResourceTagMappingListOutput() GetResourcesResourceTagMappingListOutput
	ToGetResourcesResourceTagMappingListOutputWithContext(context.Context) GetResourcesResourceTagMappingListOutput
}

GetResourcesResourceTagMappingListInput is an input type that accepts GetResourcesResourceTagMappingListArgs and GetResourcesResourceTagMappingListOutput values. You can construct a concrete instance of `GetResourcesResourceTagMappingListInput` via:

GetResourcesResourceTagMappingListArgs{...}

type GetResourcesResourceTagMappingListOutput

type GetResourcesResourceTagMappingListOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceTagMappingListOutput) ComplianceDetails

List of objects with information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.

func (GetResourcesResourceTagMappingListOutput) ElementType

func (GetResourcesResourceTagMappingListOutput) ResourceArn

ARN of the resource.

func (GetResourcesResourceTagMappingListOutput) Tags

Map of tags assigned to the resource.

func (GetResourcesResourceTagMappingListOutput) ToGetResourcesResourceTagMappingListOutput

func (o GetResourcesResourceTagMappingListOutput) ToGetResourcesResourceTagMappingListOutput() GetResourcesResourceTagMappingListOutput

func (GetResourcesResourceTagMappingListOutput) ToGetResourcesResourceTagMappingListOutputWithContext

func (o GetResourcesResourceTagMappingListOutput) ToGetResourcesResourceTagMappingListOutputWithContext(ctx context.Context) GetResourcesResourceTagMappingListOutput

type GetResourcesResult

type GetResourcesResult struct {
	ExcludeCompliantResources *bool `pulumi:"excludeCompliantResources"`
	// The provider-assigned unique ID for this managed resource.
	Id                       string   `pulumi:"id"`
	IncludeComplianceDetails *bool    `pulumi:"includeComplianceDetails"`
	ResourceArnLists         []string `pulumi:"resourceArnLists"`
	// List of objects matching the search criteria.
	ResourceTagMappingLists []GetResourcesResourceTagMappingList `pulumi:"resourceTagMappingLists"`
	ResourceTypeFilters     []string                             `pulumi:"resourceTypeFilters"`
	TagFilters              []GetResourcesTagFilter              `pulumi:"tagFilters"`
}

A collection of values returned by getResources.

func GetResources

func GetResources(ctx *pulumi.Context, args *GetResourcesArgs, opts ...pulumi.InvokeOption) (*GetResourcesResult, error)

Provides details about resource tagging.

## Example Usage

### Get All Resource Tag Mappings

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/resourcegroupstaggingapi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroupstaggingapi.GetResources(ctx, &resourcegroupstaggingapi.GetResourcesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Filter By Tag Key and Value

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/resourcegroupstaggingapi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroupstaggingapi.GetResources(ctx, &resourcegroupstaggingapi.GetResourcesArgs{
			TagFilters: []resourcegroupstaggingapi.GetResourcesTagFilter{
				{
					Key: "tag-key",
					Values: []string{
						"tag-value-1",
						"tag-value-2",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Filter By Resource Type

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/resourcegroupstaggingapi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroupstaggingapi.GetResources(ctx, &resourcegroupstaggingapi.GetResourcesArgs{
			ResourceTypeFilters: []string{
				"ec2:instance",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetResourcesResultOutput

type GetResourcesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResources.

func (GetResourcesResultOutput) ElementType

func (GetResourcesResultOutput) ElementType() reflect.Type

func (GetResourcesResultOutput) ExcludeCompliantResources

func (o GetResourcesResultOutput) ExcludeCompliantResources() pulumi.BoolPtrOutput

func (GetResourcesResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetResourcesResultOutput) IncludeComplianceDetails

func (o GetResourcesResultOutput) IncludeComplianceDetails() pulumi.BoolPtrOutput

func (GetResourcesResultOutput) ResourceArnLists

func (o GetResourcesResultOutput) ResourceArnLists() pulumi.StringArrayOutput

func (GetResourcesResultOutput) ResourceTagMappingLists

List of objects matching the search criteria.

func (GetResourcesResultOutput) ResourceTypeFilters

func (o GetResourcesResultOutput) ResourceTypeFilters() pulumi.StringArrayOutput

func (GetResourcesResultOutput) TagFilters

func (GetResourcesResultOutput) ToGetResourcesResultOutput

func (o GetResourcesResultOutput) ToGetResourcesResultOutput() GetResourcesResultOutput

func (GetResourcesResultOutput) ToGetResourcesResultOutputWithContext

func (o GetResourcesResultOutput) ToGetResourcesResultOutputWithContext(ctx context.Context) GetResourcesResultOutput

type GetResourcesTagFilter

type GetResourcesTagFilter struct {
	// One part of a key-value pair that makes up a tag.
	Key string `pulumi:"key"`
	// Optional part of a key-value pair that make up a tag.
	Values []string `pulumi:"values"`
}

type GetResourcesTagFilterArgs

type GetResourcesTagFilterArgs struct {
	// One part of a key-value pair that makes up a tag.
	Key pulumi.StringInput `pulumi:"key"`
	// Optional part of a key-value pair that make up a tag.
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetResourcesTagFilterArgs) ElementType

func (GetResourcesTagFilterArgs) ElementType() reflect.Type

func (GetResourcesTagFilterArgs) ToGetResourcesTagFilterOutput

func (i GetResourcesTagFilterArgs) ToGetResourcesTagFilterOutput() GetResourcesTagFilterOutput

func (GetResourcesTagFilterArgs) ToGetResourcesTagFilterOutputWithContext

func (i GetResourcesTagFilterArgs) ToGetResourcesTagFilterOutputWithContext(ctx context.Context) GetResourcesTagFilterOutput

type GetResourcesTagFilterArray

type GetResourcesTagFilterArray []GetResourcesTagFilterInput

func (GetResourcesTagFilterArray) ElementType

func (GetResourcesTagFilterArray) ElementType() reflect.Type

func (GetResourcesTagFilterArray) ToGetResourcesTagFilterArrayOutput

func (i GetResourcesTagFilterArray) ToGetResourcesTagFilterArrayOutput() GetResourcesTagFilterArrayOutput

func (GetResourcesTagFilterArray) ToGetResourcesTagFilterArrayOutputWithContext

func (i GetResourcesTagFilterArray) ToGetResourcesTagFilterArrayOutputWithContext(ctx context.Context) GetResourcesTagFilterArrayOutput

type GetResourcesTagFilterArrayInput

type GetResourcesTagFilterArrayInput interface {
	pulumi.Input

	ToGetResourcesTagFilterArrayOutput() GetResourcesTagFilterArrayOutput
	ToGetResourcesTagFilterArrayOutputWithContext(context.Context) GetResourcesTagFilterArrayOutput
}

GetResourcesTagFilterArrayInput is an input type that accepts GetResourcesTagFilterArray and GetResourcesTagFilterArrayOutput values. You can construct a concrete instance of `GetResourcesTagFilterArrayInput` via:

GetResourcesTagFilterArray{ GetResourcesTagFilterArgs{...} }

type GetResourcesTagFilterArrayOutput

type GetResourcesTagFilterArrayOutput struct{ *pulumi.OutputState }

func (GetResourcesTagFilterArrayOutput) ElementType

func (GetResourcesTagFilterArrayOutput) Index

func (GetResourcesTagFilterArrayOutput) ToGetResourcesTagFilterArrayOutput

func (o GetResourcesTagFilterArrayOutput) ToGetResourcesTagFilterArrayOutput() GetResourcesTagFilterArrayOutput

func (GetResourcesTagFilterArrayOutput) ToGetResourcesTagFilterArrayOutputWithContext

func (o GetResourcesTagFilterArrayOutput) ToGetResourcesTagFilterArrayOutputWithContext(ctx context.Context) GetResourcesTagFilterArrayOutput

type GetResourcesTagFilterInput

type GetResourcesTagFilterInput interface {
	pulumi.Input

	ToGetResourcesTagFilterOutput() GetResourcesTagFilterOutput
	ToGetResourcesTagFilterOutputWithContext(context.Context) GetResourcesTagFilterOutput
}

GetResourcesTagFilterInput is an input type that accepts GetResourcesTagFilterArgs and GetResourcesTagFilterOutput values. You can construct a concrete instance of `GetResourcesTagFilterInput` via:

GetResourcesTagFilterArgs{...}

type GetResourcesTagFilterOutput

type GetResourcesTagFilterOutput struct{ *pulumi.OutputState }

func (GetResourcesTagFilterOutput) ElementType

func (GetResourcesTagFilterOutput) Key

One part of a key-value pair that makes up a tag.

func (GetResourcesTagFilterOutput) ToGetResourcesTagFilterOutput

func (o GetResourcesTagFilterOutput) ToGetResourcesTagFilterOutput() GetResourcesTagFilterOutput

func (GetResourcesTagFilterOutput) ToGetResourcesTagFilterOutputWithContext

func (o GetResourcesTagFilterOutput) ToGetResourcesTagFilterOutputWithContext(ctx context.Context) GetResourcesTagFilterOutput

func (GetResourcesTagFilterOutput) Values

Optional part of a key-value pair that make up a tag.

Jump to

Keyboard shortcuts

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