pulumi-aws-kotlin/com.pulumi.aws.resourcegroupstaggingapi.kotlin/ResourcegroupstaggingapiFunctions/getResources

getResources

suspend fun getResources(argument: GetResourcesPlainArgs): GetResourcesResult

Provides details about resource tagging.

Example Usage

Get All Resource Tag Mappings

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.resourcegroupstaggingapi.ResourcegroupstaggingapiFunctions;
import com.pulumi.aws.resourcegroupstaggingapi.inputs.GetResourcesArgs;
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) {
        final var test = ResourcegroupstaggingapiFunctions.getResources();
    }
}
Content copied to clipboard

Filter By Tag Key and Value

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.resourcegroupstaggingapi.ResourcegroupstaggingapiFunctions;
import com.pulumi.aws.resourcegroupstaggingapi.inputs.GetResourcesArgs;
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) {
        final var test = ResourcegroupstaggingapiFunctions.getResources(GetResourcesArgs.builder()
            .tagFilters(GetResourcesTagFilterArgs.builder()
                .key("tag-key")
                .values(
                    "tag-value-1",
                    "tag-value-2")
                .build())
            .build());
    }
}
Content copied to clipboard

Filter By Resource Type

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.resourcegroupstaggingapi.ResourcegroupstaggingapiFunctions;
import com.pulumi.aws.resourcegroupstaggingapi.inputs.GetResourcesArgs;
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) {
        final var test = ResourcegroupstaggingapiFunctions.getResources(GetResourcesArgs.builder()
            .resourceTypeFilters("ec2:instance")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getResources.

Parameters

argument

A collection of arguments for invoking getResources.

suspend fun getResources(excludeCompliantResources: Boolean? = null, includeComplianceDetails: Boolean? = null, resourceArnLists: List<String>? = null, resourceTypeFilters: List<String>? = null, tagFilters: List<GetResourcesTagFilter>? = null): GetResourcesResult

Return

A collection of values returned by getResources.

Parameters

excludeCompliantResources

Specifies whether to exclude resources that are compliant with the tag policy. You can use this parameter only if the include_compliance_details argument is also set to true.

includeComplianceDetails

Specifies whether to include details regarding the compliance with the effective tag policy.

resourceArnLists

Specifies a list of ARNs of resources for which you want to retrieve tag data. Conflicts with filter.

resourceTypeFilters

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.

tagFilters

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

See also

.

suspend fun getResources(argument: suspend GetResourcesPlainArgsBuilder.() -> Unit): GetResourcesResult

Return

A collection of values returned by getResources.

Parameters

argument

Builder for com.pulumi.aws.resourcegroupstaggingapi.kotlin.inputs.GetResourcesPlainArgs.

See also

.