| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ResourceGroups.Types
Contents
- Service Configuration
- Errors
- GroupConfigurationStatus
- GroupFilterName
- QueryErrorCode
- QueryType
- ResourceFilterName
- ResourceStatusValue
- FailedResource
- Group
- GroupConfiguration
- GroupConfigurationItem
- GroupConfigurationParameter
- GroupFilter
- GroupIdentifier
- GroupQuery
- ListGroupResourcesItem
- PendingResource
- QueryError
- ResourceFilter
- ResourceIdentifier
- ResourceQuery
- ResourceStatus
Description
Synopsis
- defaultService :: Service
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype GroupConfigurationStatus where
- newtype GroupFilterName where
- GroupFilterName' { }
- pattern GroupFilterName_Configuration_type :: GroupFilterName
- pattern GroupFilterName_Resource_type :: GroupFilterName
- newtype QueryErrorCode where
- newtype QueryType where
- QueryType' { }
- pattern QueryType_CLOUDFORMATION_STACK_1_0 :: QueryType
- pattern QueryType_TAG_FILTERS_1_0 :: QueryType
- newtype ResourceFilterName where
- newtype ResourceStatusValue where
- data FailedResource = FailedResource' {
- resourceArn :: Maybe Text
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- newFailedResource :: FailedResource
- failedResource_resourceArn :: Lens' FailedResource (Maybe Text)
- failedResource_errorCode :: Lens' FailedResource (Maybe Text)
- failedResource_errorMessage :: Lens' FailedResource (Maybe Text)
- data Group = Group' {}
- newGroup :: Text -> Text -> Group
- group_description :: Lens' Group (Maybe Text)
- group_groupArn :: Lens' Group Text
- group_name :: Lens' Group Text
- data GroupConfiguration = GroupConfiguration' {}
- newGroupConfiguration :: GroupConfiguration
- groupConfiguration_status :: Lens' GroupConfiguration (Maybe GroupConfigurationStatus)
- groupConfiguration_failureReason :: Lens' GroupConfiguration (Maybe Text)
- groupConfiguration_proposedConfiguration :: Lens' GroupConfiguration (Maybe [GroupConfigurationItem])
- groupConfiguration_configuration :: Lens' GroupConfiguration (Maybe [GroupConfigurationItem])
- data GroupConfigurationItem = GroupConfigurationItem' {}
- newGroupConfigurationItem :: Text -> GroupConfigurationItem
- groupConfigurationItem_parameters :: Lens' GroupConfigurationItem (Maybe [GroupConfigurationParameter])
- groupConfigurationItem_type :: Lens' GroupConfigurationItem Text
- data GroupConfigurationParameter = GroupConfigurationParameter' {}
- newGroupConfigurationParameter :: Text -> GroupConfigurationParameter
- groupConfigurationParameter_values :: Lens' GroupConfigurationParameter (Maybe [Text])
- groupConfigurationParameter_name :: Lens' GroupConfigurationParameter Text
- data GroupFilter = GroupFilter' {}
- newGroupFilter :: GroupFilterName -> NonEmpty Text -> GroupFilter
- groupFilter_name :: Lens' GroupFilter GroupFilterName
- groupFilter_values :: Lens' GroupFilter (NonEmpty Text)
- data GroupIdentifier = GroupIdentifier' {}
- newGroupIdentifier :: GroupIdentifier
- groupIdentifier_groupArn :: Lens' GroupIdentifier (Maybe Text)
- groupIdentifier_groupName :: Lens' GroupIdentifier (Maybe Text)
- data GroupQuery = GroupQuery' {}
- newGroupQuery :: Text -> ResourceQuery -> GroupQuery
- groupQuery_groupName :: Lens' GroupQuery Text
- groupQuery_resourceQuery :: Lens' GroupQuery ResourceQuery
- data ListGroupResourcesItem = ListGroupResourcesItem' {}
- newListGroupResourcesItem :: ListGroupResourcesItem
- listGroupResourcesItem_status :: Lens' ListGroupResourcesItem (Maybe ResourceStatus)
- listGroupResourcesItem_identifier :: Lens' ListGroupResourcesItem (Maybe ResourceIdentifier)
- data PendingResource = PendingResource' {
- resourceArn :: Maybe Text
- newPendingResource :: PendingResource
- pendingResource_resourceArn :: Lens' PendingResource (Maybe Text)
- data QueryError = QueryError' {}
- newQueryError :: QueryError
- queryError_errorCode :: Lens' QueryError (Maybe QueryErrorCode)
- queryError_message :: Lens' QueryError (Maybe Text)
- data ResourceFilter = ResourceFilter' {}
- newResourceFilter :: ResourceFilterName -> NonEmpty Text -> ResourceFilter
- resourceFilter_name :: Lens' ResourceFilter ResourceFilterName
- resourceFilter_values :: Lens' ResourceFilter (NonEmpty Text)
- data ResourceIdentifier = ResourceIdentifier' {}
- newResourceIdentifier :: ResourceIdentifier
- resourceIdentifier_resourceType :: Lens' ResourceIdentifier (Maybe Text)
- resourceIdentifier_resourceArn :: Lens' ResourceIdentifier (Maybe Text)
- data ResourceQuery = ResourceQuery' {}
- newResourceQuery :: QueryType -> Text -> ResourceQuery
- resourceQuery_type :: Lens' ResourceQuery QueryType
- resourceQuery_searchQuery :: Lens' ResourceQuery Text
- data ResourceStatus = ResourceStatus' {}
- newResourceStatus :: ResourceStatus
- resourceStatus_name :: Lens' ResourceStatus (Maybe ResourceStatusValue)
Service Configuration
defaultService :: Service Source #
API version 2017-11-27 of the Amazon Resource Groups SDK configuration.
Errors
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The caller isn't authorized to make the request. Check permissions.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the specified resources don't exist.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've exceeded throttling limits by making too many requests in a period of time.
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal error occurred while processing the request. Try again later.
_MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request uses an HTTP method that isn't allowed for the specified resource.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it doesn't have valid credentials for the target resource.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request includes one or more parameters that violate validation rules.
GroupConfigurationStatus
newtype GroupConfigurationStatus Source #
Constructors
| GroupConfigurationStatus' | |
Fields | |
Bundled Patterns
Instances
GroupFilterName
newtype GroupFilterName Source #
Constructors
| GroupFilterName' | |
Fields | |
Bundled Patterns
| pattern GroupFilterName_Configuration_type :: GroupFilterName | |
| pattern GroupFilterName_Resource_type :: GroupFilterName |
Instances
QueryErrorCode
newtype QueryErrorCode Source #
Constructors
| QueryErrorCode' | |
Fields | |
Bundled Patterns
| pattern QueryErrorCode_CLOUDFORMATION_STACK_INACTIVE :: QueryErrorCode | |
| pattern QueryErrorCode_CLOUDFORMATION_STACK_NOT_EXISTING :: QueryErrorCode |
Instances
QueryType
Constructors
| QueryType' | |
Fields | |
Bundled Patterns
| pattern QueryType_CLOUDFORMATION_STACK_1_0 :: QueryType | |
| pattern QueryType_TAG_FILTERS_1_0 :: QueryType |
Instances
ResourceFilterName
newtype ResourceFilterName Source #
Constructors
| ResourceFilterName' | |
Fields | |
Bundled Patterns
| pattern ResourceFilterName_Resource_type :: ResourceFilterName |
Instances
ResourceStatusValue
newtype ResourceStatusValue Source #
Constructors
| ResourceStatusValue' | |
Fields | |
Bundled Patterns
| pattern ResourceStatusValue_PENDING :: ResourceStatusValue |
Instances
FailedResource
data FailedResource Source #
A resource that failed to be added to or removed from a group.
See: newFailedResource smart constructor.
Constructors
| FailedResource' | |
Fields
| |
Instances
newFailedResource :: FailedResource Source #
Create a value of FailedResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:FailedResource', failedResource_resourceArn - The ARN of the resource that failed to be added or removed.
$sel:errorCode:FailedResource', failedResource_errorCode - The error code associated with the failure.
$sel:errorMessage:FailedResource', failedResource_errorMessage - The error message text associated with the failure.
failedResource_resourceArn :: Lens' FailedResource (Maybe Text) Source #
The ARN of the resource that failed to be added or removed.
failedResource_errorCode :: Lens' FailedResource (Maybe Text) Source #
The error code associated with the failure.
failedResource_errorMessage :: Lens' FailedResource (Maybe Text) Source #
The error message text associated with the failure.
Group
A resource group that contains AWS resources. You can assign resources to the group by associating either of the following elements with the group:
- ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same AWS Region and AWS account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.
- GroupConfiguration - Use a service configuration to associate the group with an AWS service. The configuration specifies which resource types can be included in the group.
See: newGroup smart constructor.
Constructors
| Group' | |
Instances
| Eq Group Source # | |
| Read Group Source # | |
| Show Group Source # | |
| Generic Group Source # | |
| NFData Group Source # | |
Defined in Amazonka.ResourceGroups.Types.Group | |
| Hashable Group Source # | |
Defined in Amazonka.ResourceGroups.Types.Group | |
| FromJSON Group Source # | |
| type Rep Group Source # | |
Defined in Amazonka.ResourceGroups.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.ResourceGroups.Types.Group" "libZSservicesZSamazonka-resourcegroupsZSamazonka-resourcegroups" 'False) (C1 ('MetaCons "Group'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "groupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Group with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Group', group_description - The description of the resource group.
$sel:groupArn:Group', group_groupArn - The ARN of the resource group.
$sel:name:Group', group_name - The name of the resource group.
GroupConfiguration
data GroupConfiguration Source #
A service configuration associated with a resource group. The
configuration options are determined by the AWS service that defines the
Type, and specifies which resources can be included in the group. You
can add a service configuration when you create the group by using
CreateGroup, or later by using the PutGroupConfiguration operation. For
details about group service configuration syntax, see
Service configurations for resource groups.
See: newGroupConfiguration smart constructor.
Constructors
| GroupConfiguration' | |
Fields
| |
Instances
newGroupConfiguration :: GroupConfiguration Source #
Create a value of GroupConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:GroupConfiguration', groupConfiguration_status - The current status of an attempt to update the group configuration.
$sel:failureReason:GroupConfiguration', groupConfiguration_failureReason - If present, the reason why a request to update the group configuration
failed.
$sel:proposedConfiguration:GroupConfiguration', groupConfiguration_proposedConfiguration - If present, the new configuration that is in the process of being
applied to the group.
$sel:configuration:GroupConfiguration', groupConfiguration_configuration - The configuration currently associated with the group and in effect.
groupConfiguration_status :: Lens' GroupConfiguration (Maybe GroupConfigurationStatus) Source #
The current status of an attempt to update the group configuration.
groupConfiguration_failureReason :: Lens' GroupConfiguration (Maybe Text) Source #
If present, the reason why a request to update the group configuration failed.
groupConfiguration_proposedConfiguration :: Lens' GroupConfiguration (Maybe [GroupConfigurationItem]) Source #
If present, the new configuration that is in the process of being applied to the group.
groupConfiguration_configuration :: Lens' GroupConfiguration (Maybe [GroupConfigurationItem]) Source #
The configuration currently associated with the group and in effect.
GroupConfigurationItem
data GroupConfigurationItem Source #
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
See: newGroupConfigurationItem smart constructor.
Constructors
| GroupConfigurationItem' | |
Fields
| |
Instances
newGroupConfigurationItem Source #
Arguments
| :: Text | |
| -> GroupConfigurationItem |
Create a value of GroupConfigurationItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:GroupConfigurationItem', groupConfigurationItem_parameters - A collection of parameters for this group configuration item. For the
list of parameters that you can use with each configuration item type,
see
Supported resource types and parameters.
$sel:type':GroupConfigurationItem', groupConfigurationItem_type - Specifies the type of group configuration item. Each item must have a
unique value for type. For the list of types that you can specify for
a configuration item, see
Supported resource types and parameters.
groupConfigurationItem_parameters :: Lens' GroupConfigurationItem (Maybe [GroupConfigurationParameter]) Source #
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
groupConfigurationItem_type :: Lens' GroupConfigurationItem Text Source #
Specifies the type of group configuration item. Each item must have a
unique value for type. For the list of types that you can specify for
a configuration item, see
Supported resource types and parameters.
GroupConfigurationParameter
data GroupConfigurationParameter Source #
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
See: newGroupConfigurationParameter smart constructor.
Constructors
| GroupConfigurationParameter' | |
Fields
| |
Instances
newGroupConfigurationParameter Source #
Create a value of GroupConfigurationParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:GroupConfigurationParameter', groupConfigurationParameter_values - The value or values to be used for the specified parameter. For the list
of values you can use with each parameter, see
Supported resource types and parameters.
$sel:name:GroupConfigurationParameter', groupConfigurationParameter_name - The name of the group configuration parameter. For the list of
parameters that you can use with each configuration item type, see
Supported resource types and parameters.
groupConfigurationParameter_values :: Lens' GroupConfigurationParameter (Maybe [Text]) Source #
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
groupConfigurationParameter_name :: Lens' GroupConfigurationParameter Text Source #
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
GroupFilter
data GroupFilter Source #
A filter collection that you can use to restrict the results from a
List operation to only those you want to include.
See: newGroupFilter smart constructor.
Constructors
| GroupFilter' | |
Fields
| |
Instances
Arguments
| :: GroupFilterName | |
| -> NonEmpty Text | |
| -> GroupFilter |
Create a value of GroupFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:GroupFilter', groupFilter_name - The name of the filter. Filter names are case-sensitive.
$sel:values:GroupFilter', groupFilter_values - One or more filter values. Allowed filter values vary by group filter
name, and are case-sensitive.
groupFilter_name :: Lens' GroupFilter GroupFilterName Source #
The name of the filter. Filter names are case-sensitive.
groupFilter_values :: Lens' GroupFilter (NonEmpty Text) Source #
One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
GroupIdentifier
data GroupIdentifier Source #
The unique identifiers for a resource group.
See: newGroupIdentifier smart constructor.
Constructors
| GroupIdentifier' | |
Instances
newGroupIdentifier :: GroupIdentifier Source #
Create a value of GroupIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupArn:GroupIdentifier', groupIdentifier_groupArn - The ARN of the resource group.
$sel:groupName:GroupIdentifier', groupIdentifier_groupName - The name of the resource group.
groupIdentifier_groupArn :: Lens' GroupIdentifier (Maybe Text) Source #
The ARN of the resource group.
groupIdentifier_groupName :: Lens' GroupIdentifier (Maybe Text) Source #
The name of the resource group.
GroupQuery
data GroupQuery Source #
A mapping of a query attached to a resource group that determines the AWS resources that are members of the group.
See: newGroupQuery smart constructor.
Constructors
| GroupQuery' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ResourceQuery | |
| -> GroupQuery |
Create a value of GroupQuery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupName:GroupQuery', groupQuery_groupName - The name of the resource group that is associated with the specified
resource query.
$sel:resourceQuery:GroupQuery', groupQuery_resourceQuery - The resource query that determines which AWS resources are members of
the associated resource group.
groupQuery_groupName :: Lens' GroupQuery Text Source #
The name of the resource group that is associated with the specified resource query.
groupQuery_resourceQuery :: Lens' GroupQuery ResourceQuery Source #
The resource query that determines which AWS resources are members of the associated resource group.
ListGroupResourcesItem
data ListGroupResourcesItem Source #
A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.
See: newListGroupResourcesItem smart constructor.
Constructors
| ListGroupResourcesItem' | |
Fields
| |
Instances
newListGroupResourcesItem :: ListGroupResourcesItem Source #
Create a value of ListGroupResourcesItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ListGroupResourcesItem', listGroupResourcesItem_status - A structure that contains the status of this resource's membership in
the group.
This field is present in the response only if the group is of type
AWS::EC2::HostManagement.
$sel:identifier:ListGroupResourcesItem', listGroupResourcesItem_identifier - Undocumented member.
listGroupResourcesItem_status :: Lens' ListGroupResourcesItem (Maybe ResourceStatus) Source #
A structure that contains the status of this resource's membership in the group.
This field is present in the response only if the group is of type
AWS::EC2::HostManagement.
listGroupResourcesItem_identifier :: Lens' ListGroupResourcesItem (Maybe ResourceIdentifier) Source #
Undocumented member.
PendingResource
data PendingResource Source #
A structure that identifies a resource that is currently pending addition to the group as a member. Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.
See: newPendingResource smart constructor.
Constructors
| PendingResource' | |
Fields
| |
Instances
newPendingResource :: PendingResource Source #
Create a value of PendingResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:PendingResource', pendingResource_resourceArn - The Amazon resource name (ARN) of the resource that's in a pending
state.
pendingResource_resourceArn :: Lens' PendingResource (Maybe Text) Source #
The Amazon resource name (ARN) of the resource that's in a pending state.
QueryError
data QueryError Source #
A two-part error structure that can occur in ListGroupResources or
SearchResources operations on CloudFormation stack-based queries. The
error occurs if the CloudFormation stack on which the query is based
either does not exist, or has a status that renders the stack inactive.
A QueryError occurrence does not necessarily mean that AWS Resource
Groups could not complete the operation, but the resulting group might
have no member resources.
See: newQueryError smart constructor.
Constructors
| QueryError' | |
Fields
| |
Instances
newQueryError :: QueryError Source #
Create a value of QueryError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:QueryError', queryError_errorCode - Possible values are CLOUDFORMATION_STACK_INACTIVE and
CLOUDFORMATION_STACK_NOT_EXISTING.
$sel:message:QueryError', queryError_message - A message that explains the ErrorCode value. Messages might state that
the specified CloudFormation stack does not exist (or no longer exists).
For CLOUDFORMATION_STACK_INACTIVE, the message typically states that
the CloudFormation stack has a status that is not (or no longer) active,
such as CREATE_FAILED.
queryError_errorCode :: Lens' QueryError (Maybe QueryErrorCode) Source #
Possible values are CLOUDFORMATION_STACK_INACTIVE and
CLOUDFORMATION_STACK_NOT_EXISTING.
queryError_message :: Lens' QueryError (Maybe Text) Source #
A message that explains the ErrorCode value. Messages might state that
the specified CloudFormation stack does not exist (or no longer exists).
For CLOUDFORMATION_STACK_INACTIVE, the message typically states that
the CloudFormation stack has a status that is not (or no longer) active,
such as CREATE_FAILED.
ResourceFilter
data ResourceFilter Source #
A filter name and value pair that is used to obtain more specific results from a list of resources.
See: newResourceFilter smart constructor.
Constructors
| ResourceFilter' | |
Fields
| |
Instances
Arguments
| :: ResourceFilterName | |
| -> NonEmpty Text | |
| -> ResourceFilter |
Create a value of ResourceFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ResourceFilter', resourceFilter_name - The name of the filter. Filter names are case-sensitive.
$sel:values:ResourceFilter', resourceFilter_values - One or more filter values. Allowed filter values vary by resource filter
name, and are case-sensitive.
resourceFilter_name :: Lens' ResourceFilter ResourceFilterName Source #
The name of the filter. Filter names are case-sensitive.
resourceFilter_values :: Lens' ResourceFilter (NonEmpty Text) Source #
One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
ResourceIdentifier
data ResourceIdentifier Source #
A structure that contains the ARN of a resource and its resource type.
See: newResourceIdentifier smart constructor.
Constructors
| ResourceIdentifier' | |
Fields
| |
Instances
newResourceIdentifier :: ResourceIdentifier Source #
Create a value of ResourceIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceType:ResourceIdentifier', resourceIdentifier_resourceType - The resource type of a resource, such as AWS::EC2::Instance.
$sel:resourceArn:ResourceIdentifier', resourceIdentifier_resourceArn - The ARN of a resource.
resourceIdentifier_resourceType :: Lens' ResourceIdentifier (Maybe Text) Source #
The resource type of a resource, such as AWS::EC2::Instance.
resourceIdentifier_resourceArn :: Lens' ResourceIdentifier (Maybe Text) Source #
The ARN of a resource.
ResourceQuery
data ResourceQuery Source #
The query that is used to define a resource group or a search for resources. A query specifies both a query type and a query string as a JSON object. See the examples section for example JSON strings.
The examples that follow are shown as standard JSON strings. If you include such a string as a parameter to the AWS CLI or an SDK API, you might need to 'escape' the string into a single line. For example, see the Quoting strings in the AWS CLI User Guide.
Example 1
The following generic example shows a resource query JSON string that includes only resources that meet the following criteria:
- The resource type must be either
resource_type1orresource_type2. - The resource must have a tag
Key1with a value of eitherValueAorValueB. - The resource must have a tag
Key2with a value of eitherValueCorValueD.
{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": [ "resource_type1", "resource_type2"], "TagFilters": [ { "Key": "Key1", "Values": ["ValueA","ValueB"] }, { "Key":"Key2", "Values":["ValueC","ValueD"] } ] } }This has the equivalent "shortcut" syntax of the following:
{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": [ "resource_type1", "resource_type2"], "TagFilters": [ { "Key1": ["ValueA","ValueB"] }, { "Key2": ["ValueC","ValueD"] } ] } }Example 2
The following example shows a resource query JSON string that includes
only Amazon EC2 instances that are tagged Stage with a value of
Test.
{ "Type": "TAG_FILTERS_1_0", "Query": "{ "ResourceTypeFilters": "AWS::EC2::Instance", "TagFilters": { "Stage": "Test" } } }Example 3
The following example shows a resource query JSON string that includes
resource of any supported type as long as it is tagged Stage with a
value of Prod.
{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": "AWS::AllSupported", "TagFilters": { "Stage": "Prod" } } }Example 4
The following example shows a resource query JSON string that includes only Amazon EC2 instances and Amazon S3 buckets that are part of the specified AWS CloudFormation stack.
{ "Type": "CLOUDFORMATION_STACK_1_0", "Query": { "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ], "StackIdentifier": "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE" } }See: newResourceQuery smart constructor.
Constructors
| ResourceQuery' | |
Fields
| |
Instances
Create a value of ResourceQuery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':ResourceQuery', resourceQuery_type - The type of the query. You can use the following values:
CLOUDFORMATION_STACK_1_0:Specifies that theQuerycontains an ARN for a CloudFormation stack.TAG_FILTERS_1_0:Specifies that theQueryparameter contains a JSON string that represents a collection of simple tag filters for resource types and tags. The JSON string uses a syntax similar to theGetResourcesoperation, but uses only theResourceTypeFiltersandTagFiltersfields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.For example, consider the following sample query for resources that have two tags,
StageandVersion, with two values each:[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]The results of this query could include the following.
- An EC2 instance that has the following two tags:
{"Stage":"Deploy"}, and{"Version":"2"} - An S3 bucket that has the following two tags:
{"Stage":"Test"}, and{"Version":"1"}
The query would not include the following items in the results, however.
An EC2 instance that has only the following tag:
{"Stage":"Deploy"}.The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
- An EC2 instance that has the following two tags:
$sel:query:ResourceQuery', resourceQuery_searchQuery - The query that defines a group or a search.
resourceQuery_type :: Lens' ResourceQuery QueryType Source #
The type of the query. You can use the following values:
CLOUDFORMATION_STACK_1_0:Specifies that theQuerycontains an ARN for a CloudFormation stack.TAG_FILTERS_1_0:Specifies that theQueryparameter contains a JSON string that represents a collection of simple tag filters for resource types and tags. The JSON string uses a syntax similar to theGetResourcesoperation, but uses only theResourceTypeFiltersandTagFiltersfields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.For example, consider the following sample query for resources that have two tags,
StageandVersion, with two values each:[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]The results of this query could include the following.
- An EC2 instance that has the following two tags:
{"Stage":"Deploy"}, and{"Version":"2"} - An S3 bucket that has the following two tags:
{"Stage":"Test"}, and{"Version":"1"}
The query would not include the following items in the results, however.
An EC2 instance that has only the following tag:
{"Stage":"Deploy"}.The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
- An EC2 instance that has the following two tags:
resourceQuery_searchQuery :: Lens' ResourceQuery Text Source #
The query that defines a group or a search.
ResourceStatus
data ResourceStatus Source #
A structure that identifies the current group membership status for a
resource. Adding a resource to a resource group is performed
asynchronously as a background task. A PENDING status indicates, for
this resource, that the process isn't completed yet.
See: newResourceStatus smart constructor.
Constructors
| ResourceStatus' | |
Fields
| |
Instances
newResourceStatus :: ResourceStatus Source #
Create a value of ResourceStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ResourceStatus', resourceStatus_name - The current status.
resourceStatus_name :: Lens' ResourceStatus (Maybe ResourceStatusValue) Source #
The current status.