aws-cdk-lib 2.171.1__py3-none-any.whl → 2.173.0__py3-none-any.whl

aws_cdk/aws_resourcegroups/__init__.py

@@ -317,8 +317,8 @@ class CfnGroup(
 
             A service configuration can consist of one or more items. For details service configurations and how to construct them, see `Service configurations for resource groups <https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html>`_ in the *AWS Resource Groups User Guide* .
 
-            :param parameters: A collection of parameters for this configuration item. For the list of parameters that you can use with each configuration item ``Type`` , see `Supported resource types and parameters <https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
-            :param type: Specifies the type of configuration item. Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see `Supported resource types and parameters <https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
+            :param parameters: A collection of parameters for this configuration item. For the list of parameters that you can use with each configuration item ``Type`` , see `Supported resource types and parameters <https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
+            :param type: Specifies the type of configuration item. Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see `Supported resource types and parameters <https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html
             :exampleMetadata: fixture=_generated
@@ -353,7 +353,7 @@ class CfnGroup(
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGroup.ConfigurationParameterProperty"]]]]:
             '''A collection of parameters for this configuration item.
 
-            For the list of parameters that you can use with each configuration item ``Type`` , see `Supported resource types and parameters <https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
+            For the list of parameters that you can use with each configuration item ``Type`` , see `Supported resource types and parameters <https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-parameters
             '''
@@ -364,7 +364,7 @@ class CfnGroup(
         def type(self) -> typing.Optional[builtins.str]:
             '''Specifies the type of configuration item.
 
-            Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see `Supported resource types and parameters <https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
+            Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see `Supported resource types and parameters <https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types>`_ in the *AWS Resource Groups User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-type
             '''
@@ -923,9 +923,309 @@ class CfnGroupProps:
         )
 
 
+@jsii.implements(_IInspectable_c2943556)
+class CfnTagSyncTask(
+    _CfnResource_9df397a6,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.aws_resourcegroups.CfnTagSyncTask",
+):
+    '''Onboards and syncs resources tagged with a specific tag key-value pair to an application.
+
+    *Minimum permissions*
+
+    To run this command, you must have the following permissions:
+
+    - ``resource-groups:StartTagSyncTask``
+    - ``resource-groups:CreateGroup``
+    - ``iam:PassRole`` for the role you provide to create a tag-sync task
+
+    :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html
+    :cloudformationResource: AWS::ResourceGroups::TagSyncTask
+    :exampleMetadata: fixture=_generated
+
+    Example::
+
+        # The code below shows an example of how to instantiate this type.
+        # The values are placeholders you should change.
+        from aws_cdk import aws_resourcegroups as resourcegroups
+        
+        cfn_tag_sync_task = resourcegroups.CfnTagSyncTask(self, "MyCfnTagSyncTask",
+            group="group",
+            role_arn="roleArn",
+            tag_key="tagKey",
+            tag_value="tagValue"
+        )
+    '''
+
+    def __init__(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        id: builtins.str,
+        *,
+        group: builtins.str,
+        role_arn: builtins.str,
+        tag_key: builtins.str,
+        tag_value: builtins.str,
+    ) -> None:
+        '''
+        :param scope: Scope in which this resource is defined.
+        :param id: Construct identifier for this resource (unique in its scope).
+        :param group: The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
+        :param role_arn: The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+        :param tag_key: The tag key.
+        :param tag_value: The tag value.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__5cc3fe2babfae90c2893ec2e64dba324eb7f1354bc8586a2157b1e9493be9d2a)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+        props = CfnTagSyncTaskProps(
+            group=group, role_arn=role_arn, tag_key=tag_key, tag_value=tag_value
+        )
+
+        jsii.create(self.__class__, self, [scope, id, props])
+
+    @jsii.member(jsii_name="inspect")
+    def inspect(self, inspector: _TreeInspector_488e0dd5) -> None:
+        '''Examines the CloudFormation resource and discloses attributes.
+
+        :param inspector: tree inspector to collect and process attributes.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__fa39f02686575059144fa82b37d1e2e3bbec0b2f0f8b1503d29a8202955b1d71)
+            check_type(argname="argument inspector", value=inspector, expected_type=type_hints["inspector"])
+        return typing.cast(None, jsii.invoke(self, "inspect", [inspector]))
+
+    @jsii.member(jsii_name="renderProperties")
+    def _render_properties(
+        self,
+        props: typing.Mapping[builtins.str, typing.Any],
+    ) -> typing.Mapping[builtins.str, typing.Any]:
+        '''
+        :param props: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__f5e39aeb093662e365e0c8f8da41ae7f18912a09e014a840fd4e0a3eea585462)
+            check_type(argname="argument props", value=props, expected_type=type_hints["props"])
+        return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "renderProperties", [props]))
+
+    @jsii.python.classproperty
+    @jsii.member(jsii_name="CFN_RESOURCE_TYPE_NAME")
+    def CFN_RESOURCE_TYPE_NAME(cls) -> builtins.str:
+        '''The CloudFormation resource type name for this resource class.'''
+        return typing.cast(builtins.str, jsii.sget(cls, "CFN_RESOURCE_TYPE_NAME"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrGroupArn")
+    def attr_group_arn(self) -> builtins.str:
+        '''The Amazon resource name (ARN) of the application group.
+
+        :cloudformationAttribute: GroupArn
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrGroupArn"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrGroupName")
+    def attr_group_name(self) -> builtins.str:
+        '''The name of the application group.
+
+        :cloudformationAttribute: GroupName
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrGroupName"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrStatus")
+    def attr_status(self) -> builtins.str:
+        '''The status of the tag-sync task.
+
+        Valid values include:
+
+        - ``ACTIVE`` - The tag-sync task is actively managing resources in the application by adding or removing the ``awsApplication`` tag from resources when they are tagged or untagged with the specified tag key-value pair.
+        - ``ERROR`` - The tag-sync task is not actively managing resources in the application. Review the ``ErrorMessage`` for more information about resolving the error.
+
+        :cloudformationAttribute: Status
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrTaskArn")
+    def attr_task_arn(self) -> builtins.str:
+        '''The Amazon resource name (ARN) of the tag-sync task.
+
+        :cloudformationAttribute: TaskArn
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrTaskArn"))
+
+    @builtins.property
+    @jsii.member(jsii_name="cfnProperties")
+    def _cfn_properties(self) -> typing.Mapping[builtins.str, typing.Any]:
+        return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.get(self, "cfnProperties"))
+
+    @builtins.property
+    @jsii.member(jsii_name="group")
+    def group(self) -> builtins.str:
+        '''The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.'''
+        return typing.cast(builtins.str, jsii.get(self, "group"))
+
+    @group.setter
+    def group(self, value: builtins.str) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__d133f44d39c629bca40a85ade7619a80aef78c5629c6cdd2f74b840c6b4cd745)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "group", value) # pyright: ignore[reportArgumentType]
+
+    @builtins.property
+    @jsii.member(jsii_name="roleArn")
+    def role_arn(self) -> builtins.str:
+        '''The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.'''
+        return typing.cast(builtins.str, jsii.get(self, "roleArn"))
+
+    @role_arn.setter
+    def role_arn(self, value: builtins.str) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__be46018b4db2c0ed820aeae0051f1b794bdebae8736cd97e2b08cf2bf5d3a673)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "roleArn", value) # pyright: ignore[reportArgumentType]
+
+    @builtins.property
+    @jsii.member(jsii_name="tagKey")
+    def tag_key(self) -> builtins.str:
+        '''The tag key.'''
+        return typing.cast(builtins.str, jsii.get(self, "tagKey"))
+
+    @tag_key.setter
+    def tag_key(self, value: builtins.str) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__36f0fe44c7515735b59ea6297b6cb7c5a2b5bddb1a4da3e9f0910baab1d7d5d9)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "tagKey", value) # pyright: ignore[reportArgumentType]
+
+    @builtins.property
+    @jsii.member(jsii_name="tagValue")
+    def tag_value(self) -> builtins.str:
+        '''The tag value.'''
+        return typing.cast(builtins.str, jsii.get(self, "tagValue"))
+
+    @tag_value.setter
+    def tag_value(self, value: builtins.str) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__66392dc23dc3e7ed8bf3c5d524bd90c2953712bb7e49a797537fda8d836525c3)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "tagValue", value) # pyright: ignore[reportArgumentType]
+
+
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_resourcegroups.CfnTagSyncTaskProps",
+    jsii_struct_bases=[],
+    name_mapping={
+        "group": "group",
+        "role_arn": "roleArn",
+        "tag_key": "tagKey",
+        "tag_value": "tagValue",
+    },
+)
+class CfnTagSyncTaskProps:
+    def __init__(
+        self,
+        *,
+        group: builtins.str,
+        role_arn: builtins.str,
+        tag_key: builtins.str,
+        tag_value: builtins.str,
+    ) -> None:
+        '''Properties for defining a ``CfnTagSyncTask``.
+
+        :param group: The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
+        :param role_arn: The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+        :param tag_key: The tag key.
+        :param tag_value: The tag value.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html
+        :exampleMetadata: fixture=_generated
+
+        Example::
+
+            # The code below shows an example of how to instantiate this type.
+            # The values are placeholders you should change.
+            from aws_cdk import aws_resourcegroups as resourcegroups
+            
+            cfn_tag_sync_task_props = resourcegroups.CfnTagSyncTaskProps(
+                group="group",
+                role_arn="roleArn",
+                tag_key="tagKey",
+                tag_value="tagValue"
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__92e2f4c3b48ee7233cae450c356891144695748bdb5f027bc5b13135d8eeea4e)
+            check_type(argname="argument group", value=group, expected_type=type_hints["group"])
+            check_type(argname="argument role_arn", value=role_arn, expected_type=type_hints["role_arn"])
+            check_type(argname="argument tag_key", value=tag_key, expected_type=type_hints["tag_key"])
+            check_type(argname="argument tag_value", value=tag_value, expected_type=type_hints["tag_value"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "group": group,
+            "role_arn": role_arn,
+            "tag_key": tag_key,
+            "tag_value": tag_value,
+        }
+
+    @builtins.property
+    def group(self) -> builtins.str:
+        '''The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-group
+        '''
+        result = self._values.get("group")
+        assert result is not None, "Required property 'group' is missing"
+        return typing.cast(builtins.str, result)
+
+    @builtins.property
+    def role_arn(self) -> builtins.str:
+        '''The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-rolearn
+        '''
+        result = self._values.get("role_arn")
+        assert result is not None, "Required property 'role_arn' is missing"
+        return typing.cast(builtins.str, result)
+
+    @builtins.property
+    def tag_key(self) -> builtins.str:
+        '''The tag key.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagkey
+        '''
+        result = self._values.get("tag_key")
+        assert result is not None, "Required property 'tag_key' is missing"
+        return typing.cast(builtins.str, result)
+
+    @builtins.property
+    def tag_value(self) -> builtins.str:
+        '''The tag value.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagvalue
+        '''
+        result = self._values.get("tag_value")
+        assert result is not None, "Required property 'tag_value' is missing"
+        return typing.cast(builtins.str, result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "CfnTagSyncTaskProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 __all__ = [
     "CfnGroup",
     "CfnGroupProps",
+    "CfnTagSyncTask",
+    "CfnTagSyncTaskProps",
 ]
 
 publication.publish()
@@ -1044,3 +1344,61 @@ def _typecheckingstub__fb026100b2da91b258c8101dddf16a77684d48ca689302721dfecf0e2
 ) -> None:
     """Type checking stubs"""
     pass
+
+def _typecheckingstub__5cc3fe2babfae90c2893ec2e64dba324eb7f1354bc8586a2157b1e9493be9d2a(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    *,
+    group: builtins.str,
+    role_arn: builtins.str,
+    tag_key: builtins.str,
+    tag_value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__fa39f02686575059144fa82b37d1e2e3bbec0b2f0f8b1503d29a8202955b1d71(
+    inspector: _TreeInspector_488e0dd5,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__f5e39aeb093662e365e0c8f8da41ae7f18912a09e014a840fd4e0a3eea585462(
+    props: typing.Mapping[builtins.str, typing.Any],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__d133f44d39c629bca40a85ade7619a80aef78c5629c6cdd2f74b840c6b4cd745(
+    value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__be46018b4db2c0ed820aeae0051f1b794bdebae8736cd97e2b08cf2bf5d3a673(
+    value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__36f0fe44c7515735b59ea6297b6cb7c5a2b5bddb1a4da3e9f0910baab1d7d5d9(
+    value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__66392dc23dc3e7ed8bf3c5d524bd90c2953712bb7e49a797537fda8d836525c3(
+    value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__92e2f4c3b48ee7233cae450c356891144695748bdb5f027bc5b13135d8eeea4e(
+    *,
+    group: builtins.str,
+    role_arn: builtins.str,
+    tag_key: builtins.str,
+    tag_value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass