aws-cdk-lib 2.136.1__py3-none-any.whl → 2.138.0__py3-none-any.whl

aws_cdk/aws_codeconnections/__init__.py

@@ -0,0 +1,435 @@
+'''
+# AWS::CodeConnections Construct Library
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
+
+> All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use.
+
+---
+<!--END STABILITY BANNER-->
+
+This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
+
+```python
+import aws_cdk.aws_codeconnections as codeconnections
+```
+
+<!--BEGIN CFNONLY DISCLAIMER-->
+
+There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:
+
+* Search [Construct Hub for CodeConnections construct libraries](https://constructs.dev/search?q=codeconnections)
+* Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::CodeConnections resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_CodeConnections.html) directly.
+
+<!--BEGIN CFNONLY DISCLAIMER-->
+
+There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
+However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.
+
+For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::CodeConnections](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_CodeConnections.html).
+
+(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)
+
+<!--END CFNONLY DISCLAIMER-->
+'''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+from typeguard import check_type
+
+from .._jsii import *
+
+import constructs as _constructs_77d1e7e8
+from .. import (
+    CfnResource as _CfnResource_9df397a6,
+    CfnTag as _CfnTag_f6864754,
+    IInspectable as _IInspectable_c2943556,
+    ITaggableV2 as _ITaggableV2_4e6798f8,
+    TagManager as _TagManager_0a598cb3,
+    TreeInspector as _TreeInspector_488e0dd5,
+)
+
+
+@jsii.implements(_IInspectable_c2943556, _ITaggableV2_4e6798f8)
+class CfnConnection(
+    _CfnResource_9df397a6,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.aws_codeconnections.CfnConnection",
+):
+    '''A resource that is used to connect third-party source providers with services like CodePipeline.
+
+    Note: A connection created through AWS CloudFormation , the CLI, or the SDK is in ``PENDING`` status by default. You can make its status ``AVAILABLE`` by updating the connection in the console.
+
+    :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html
+    :cloudformationResource: AWS::CodeConnections::Connection
+    :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_codeconnections as codeconnections
+        
+        cfn_connection = codeconnections.CfnConnection(self, "MyCfnConnection",
+            connection_name="connectionName",
+        
+            # the properties below are optional
+            host_arn="hostArn",
+            provider_type="providerType",
+            tags=[CfnTag(
+                key="key",
+                value="value"
+            )]
+        )
+    '''
+
+    def __init__(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        id: builtins.str,
+        *,
+        connection_name: builtins.str,
+        host_arn: typing.Optional[builtins.str] = None,
+        provider_type: typing.Optional[builtins.str] = None,
+        tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
+    ) -> None:
+        '''
+        :param scope: Scope in which this resource is defined.
+        :param id: Construct identifier for this resource (unique in its scope).
+        :param connection_name: The name of the connection. Connection names must be unique in an AWS account .
+        :param host_arn: The Amazon Resource Name (ARN) of the host associated with the connection.
+        :param provider_type: The name of the external provider where your third-party code repository is configured.
+        :param tags: Specifies the tags applied to a connection.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__da00c1ce515c51afa7843809dadd2cb48a76e0e91dd2a8096cc430768e89a815)
+            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 = CfnConnectionProps(
+            connection_name=connection_name,
+            host_arn=host_arn,
+            provider_type=provider_type,
+            tags=tags,
+        )
+
+        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__78744497e1b5bae3f2ea20b9d3496e178855aef0e29d2de71777b026a6d27a1a)
+            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__440f5e3662e5ab05ab71cf41aafae8bf45c3a11a457c7bbc13517a3eb9e7278e)
+            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="attrConnectionArn")
+    def attr_connection_arn(self) -> builtins.str:
+        '''The Amazon Resource Name (ARN) of the connection.
+
+        The ARN is used as the connection reference when the connection is shared between AWS services .
+        .. epigraph::
+
+           The ARN is never reused if the connection is deleted.
+
+        :cloudformationAttribute: ConnectionArn
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrConnectionArn"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrConnectionStatus")
+    def attr_connection_status(self) -> builtins.str:
+        '''The current status of the connection.
+
+        :cloudformationAttribute: ConnectionStatus
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrConnectionStatus"))
+
+    @builtins.property
+    @jsii.member(jsii_name="attrOwnerAccountId")
+    def attr_owner_account_id(self) -> builtins.str:
+        '''The identifier of the external provider where your third-party code repository is configured.
+
+        For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
+
+        :cloudformationAttribute: OwnerAccountId
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrOwnerAccountId"))
+
+    @builtins.property
+    @jsii.member(jsii_name="cdkTagManager")
+    def cdk_tag_manager(self) -> _TagManager_0a598cb3:
+        '''Tag Manager which manages the tags for this resource.'''
+        return typing.cast(_TagManager_0a598cb3, jsii.get(self, "cdkTagManager"))
+
+    @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="connectionName")
+    def connection_name(self) -> builtins.str:
+        '''The name of the connection.'''
+        return typing.cast(builtins.str, jsii.get(self, "connectionName"))
+
+    @connection_name.setter
+    def connection_name(self, value: builtins.str) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__7d759fec9e0861542e9267cd70eacda49ebbb2a1399fb2f36364a2a01d38cdc0)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "connectionName", value)
+
+    @builtins.property
+    @jsii.member(jsii_name="hostArn")
+    def host_arn(self) -> typing.Optional[builtins.str]:
+        '''The Amazon Resource Name (ARN) of the host associated with the connection.'''
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "hostArn"))
+
+    @host_arn.setter
+    def host_arn(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__6c6c22c4d5132fe518d2a74aed1b6d9c89f7a2fbb163195a459d8af8791cf1c9)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "hostArn", value)
+
+    @builtins.property
+    @jsii.member(jsii_name="providerType")
+    def provider_type(self) -> typing.Optional[builtins.str]:
+        '''The name of the external provider where your third-party code repository is configured.'''
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "providerType"))
+
+    @provider_type.setter
+    def provider_type(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__2ec396e84dc4ee92669ed87aa685780cf9af74b974c8d0d7f12b0c1196dc17d6)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "providerType", value)
+
+    @builtins.property
+    @jsii.member(jsii_name="tags")
+    def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
+        '''Specifies the tags applied to a connection.'''
+        return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
+
+    @tags.setter
+    def tags(self, value: typing.Optional[typing.List[_CfnTag_f6864754]]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__cd277a1214d747c2b8b1a0998909d0fe0edc54719c5d7b8ae3621585dbf60405)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "tags", value)
+
+
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_codeconnections.CfnConnectionProps",
+    jsii_struct_bases=[],
+    name_mapping={
+        "connection_name": "connectionName",
+        "host_arn": "hostArn",
+        "provider_type": "providerType",
+        "tags": "tags",
+    },
+)
+class CfnConnectionProps:
+    def __init__(
+        self,
+        *,
+        connection_name: builtins.str,
+        host_arn: typing.Optional[builtins.str] = None,
+        provider_type: typing.Optional[builtins.str] = None,
+        tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
+    ) -> None:
+        '''Properties for defining a ``CfnConnection``.
+
+        :param connection_name: The name of the connection. Connection names must be unique in an AWS account .
+        :param host_arn: The Amazon Resource Name (ARN) of the host associated with the connection.
+        :param provider_type: The name of the external provider where your third-party code repository is configured.
+        :param tags: Specifies the tags applied to a connection.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.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_codeconnections as codeconnections
+            
+            cfn_connection_props = codeconnections.CfnConnectionProps(
+                connection_name="connectionName",
+            
+                # the properties below are optional
+                host_arn="hostArn",
+                provider_type="providerType",
+                tags=[CfnTag(
+                    key="key",
+                    value="value"
+                )]
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__4ac62d1262e0fc9d7647548096d4e83c0367271b1f1be70c2119c14ec99b3dde)
+            check_type(argname="argument connection_name", value=connection_name, expected_type=type_hints["connection_name"])
+            check_type(argname="argument host_arn", value=host_arn, expected_type=type_hints["host_arn"])
+            check_type(argname="argument provider_type", value=provider_type, expected_type=type_hints["provider_type"])
+            check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "connection_name": connection_name,
+        }
+        if host_arn is not None:
+            self._values["host_arn"] = host_arn
+        if provider_type is not None:
+            self._values["provider_type"] = provider_type
+        if tags is not None:
+            self._values["tags"] = tags
+
+    @builtins.property
+    def connection_name(self) -> builtins.str:
+        '''The name of the connection.
+
+        Connection names must be unique in an AWS account .
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-connectionname
+        '''
+        result = self._values.get("connection_name")
+        assert result is not None, "Required property 'connection_name' is missing"
+        return typing.cast(builtins.str, result)
+
+    @builtins.property
+    def host_arn(self) -> typing.Optional[builtins.str]:
+        '''The Amazon Resource Name (ARN) of the host associated with the connection.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-hostarn
+        '''
+        result = self._values.get("host_arn")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def provider_type(self) -> typing.Optional[builtins.str]:
+        '''The name of the external provider where your third-party code repository is configured.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-providertype
+        '''
+        result = self._values.get("provider_type")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
+        '''Specifies the tags applied to a connection.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-tags
+        '''
+        result = self._values.get("tags")
+        return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], 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 "CfnConnectionProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
+__all__ = [
+    "CfnConnection",
+    "CfnConnectionProps",
+]
+
+publication.publish()
+
+def _typecheckingstub__da00c1ce515c51afa7843809dadd2cb48a76e0e91dd2a8096cc430768e89a815(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    *,
+    connection_name: builtins.str,
+    host_arn: typing.Optional[builtins.str] = None,
+    provider_type: typing.Optional[builtins.str] = None,
+    tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__78744497e1b5bae3f2ea20b9d3496e178855aef0e29d2de71777b026a6d27a1a(
+    inspector: _TreeInspector_488e0dd5,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__440f5e3662e5ab05ab71cf41aafae8bf45c3a11a457c7bbc13517a3eb9e7278e(
+    props: typing.Mapping[builtins.str, typing.Any],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__7d759fec9e0861542e9267cd70eacda49ebbb2a1399fb2f36364a2a01d38cdc0(
+    value: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__6c6c22c4d5132fe518d2a74aed1b6d9c89f7a2fbb163195a459d8af8791cf1c9(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__2ec396e84dc4ee92669ed87aa685780cf9af74b974c8d0d7f12b0c1196dc17d6(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__cd277a1214d747c2b8b1a0998909d0fe0edc54719c5d7b8ae3621585dbf60405(
+    value: typing.Optional[typing.List[_CfnTag_f6864754]],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__4ac62d1262e0fc9d7647548096d4e83c0367271b1f1be70c2119c14ec99b3dde(
+    *,
+    connection_name: builtins.str,
+    host_arn: typing.Optional[builtins.str] = None,
+    provider_type: typing.Optional[builtins.str] = None,
+    tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass