This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.
resourcegroups¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
- class
pulumi_aws.resourcegroups.Group(resource_name, opts=None, description=None, name=None, resource_query=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides a Resource Group.
import pulumi import pulumi_aws as aws test = aws.resourcegroups.Group("test", resource_query={ "query": """{ "ResourceTypeFilters": [ "AWS::EC2::Instance" ], "TagFilters": [ { "Key": "Stage", "Values": ["Test"] } ] } """, })
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the resource group.
name (pulumi.Input[str]) – 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
AWSoraws.resource_query (pulumi.Input[dict]) – A
resource_queryblock. Resource queries are documented below.tags (pulumi.Input[dict]) – Key-value map of resource tags
The resource_query object supports the following:
query(pulumi.Input[str]) - The resource query as a JSON string.type(pulumi.Input[str]) - The type of the resource query. Defaults toTAG_FILTERS_1_0.
arn: pulumi.Output[str] = None¶The ARN assigned by AWS for this resource group.
description: pulumi.Output[str] = None¶A description of the resource group.
name: pulumi.Output[str] = None¶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
AWSoraws.
resource_query: pulumi.Output[dict] = None¶A
resource_queryblock. Resource queries are documented below.query(str) - The resource query as a JSON string.type(str) - The type of the resource query. Defaults toTAG_FILTERS_1_0.
Key-value map of resource tags
- static
get(resource_name, id, opts=None, arn=None, description=None, name=None, resource_query=None, tags=None)¶ Get an existing Group resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN assigned by AWS for this resource group.
description (pulumi.Input[str]) – A description of the resource group.
name (pulumi.Input[str]) – 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
AWSoraws.resource_query (pulumi.Input[dict]) – A
resource_queryblock. Resource queries are documented below.tags (pulumi.Input[dict]) – Key-value map of resource tags
The resource_query object supports the following:
query(pulumi.Input[str]) - The resource query as a JSON string.type(pulumi.Input[str]) - The type of the resource query. Defaults toTAG_FILTERS_1_0.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str