diff options
Diffstat (limited to 'python-aws-cdk-region-info.spec')
| -rw-r--r-- | python-aws-cdk-region-info.spec | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/python-aws-cdk-region-info.spec b/python-aws-cdk-region-info.spec new file mode 100644 index 0000000..25a6df8 --- /dev/null +++ b/python-aws-cdk-region-info.spec @@ -0,0 +1,219 @@ +%global _empty_manifest_terminate_build 0 +Name: python-aws-cdk.region-info +Version: 2.73.0 +Release: 1 +Summary: AWS region information, such as service principal names +License: Apache-2.0 +URL: https://github.com/aws/aws-cdk +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/22/22/c1563dc8d50fc50b925a63c679afaf718fc97020920e5519b4416f9f3281/aws-cdk.region-info-2.73.0.tar.gz +BuildArch: noarch + +Requires: python3-jsii +Requires: python3-publication +Requires: python3-typeguard + +%description +<!--END STABILITY BANNER--> +## Usage +Some information used in CDK Applications differs from one AWS region to +another, such as service principals used in IAM policies, S3 static website +endpoints, ... +### The `RegionInfo` class +The library offers a simple interface to obtain region specific information in +the form of the `RegionInfo` class. This is the preferred way to interact with +the regional information database: +```python +# Get the information for "eu-west-1": +region = region_info.RegionInfo.get("eu-west-1") +# Access attributes: +region.s3_static_website_endpoint # s3-website-eu-west-1.amazonaws.com +region.service_principal("logs.amazonaws.com") +``` +The `RegionInfo` layer is built on top of the Low-Level API, which is described +below and can be used to register additional data, including user-defined facts +that are not available through the `RegionInfo` interface. +### Low-Level API +This library offers a primitive database of such information so that CDK +constructs can easily access regional information. The `FactName` class provides +a list of known fact names, which can then be used with the `RegionInfo` to +retrieve a particular value: +```python +code_deploy_principal = region_info.Fact.find("us-east-1", region_info.FactName.service_principal("codedeploy.amazonaws.com")) +# => codedeploy.us-east-1.amazonaws.com +static_website = region_info.Fact.find("ap-northeast-1", region_info.FactName.S3_STATIC_WEBSITE_ENDPOINT) +``` +## Supplying new or missing information +As new regions are released, it might happen that a particular fact you need is +missing from the library. In such cases, the `Fact.register` method can be used +to inject FactName into the database: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact()) +``` +## Overriding incorrect information +In the event information provided by the library is incorrect, it can be +overridden using the same `Fact.register` method demonstrated above, simply +adding an extra boolean argument: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact(), True) +``` +If you happen to have stumbled upon incorrect data built into this library, it +is always a good idea to report your findings in a [GitHub issue](https://github.com/aws/aws-cdk/issues), so we can fix + +%package -n python3-aws-cdk.region-info +Summary: AWS region information, such as service principal names +Provides: python-aws-cdk.region-info +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-aws-cdk.region-info +<!--END STABILITY BANNER--> +## Usage +Some information used in CDK Applications differs from one AWS region to +another, such as service principals used in IAM policies, S3 static website +endpoints, ... +### The `RegionInfo` class +The library offers a simple interface to obtain region specific information in +the form of the `RegionInfo` class. This is the preferred way to interact with +the regional information database: +```python +# Get the information for "eu-west-1": +region = region_info.RegionInfo.get("eu-west-1") +# Access attributes: +region.s3_static_website_endpoint # s3-website-eu-west-1.amazonaws.com +region.service_principal("logs.amazonaws.com") +``` +The `RegionInfo` layer is built on top of the Low-Level API, which is described +below and can be used to register additional data, including user-defined facts +that are not available through the `RegionInfo` interface. +### Low-Level API +This library offers a primitive database of such information so that CDK +constructs can easily access regional information. The `FactName` class provides +a list of known fact names, which can then be used with the `RegionInfo` to +retrieve a particular value: +```python +code_deploy_principal = region_info.Fact.find("us-east-1", region_info.FactName.service_principal("codedeploy.amazonaws.com")) +# => codedeploy.us-east-1.amazonaws.com +static_website = region_info.Fact.find("ap-northeast-1", region_info.FactName.S3_STATIC_WEBSITE_ENDPOINT) +``` +## Supplying new or missing information +As new regions are released, it might happen that a particular fact you need is +missing from the library. In such cases, the `Fact.register` method can be used +to inject FactName into the database: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact()) +``` +## Overriding incorrect information +In the event information provided by the library is incorrect, it can be +overridden using the same `Fact.register` method demonstrated above, simply +adding an extra boolean argument: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact(), True) +``` +If you happen to have stumbled upon incorrect data built into this library, it +is always a good idea to report your findings in a [GitHub issue](https://github.com/aws/aws-cdk/issues), so we can fix + +%package help +Summary: Development documents and examples for aws-cdk.region-info +Provides: python3-aws-cdk.region-info-doc +%description help +<!--END STABILITY BANNER--> +## Usage +Some information used in CDK Applications differs from one AWS region to +another, such as service principals used in IAM policies, S3 static website +endpoints, ... +### The `RegionInfo` class +The library offers a simple interface to obtain region specific information in +the form of the `RegionInfo` class. This is the preferred way to interact with +the regional information database: +```python +# Get the information for "eu-west-1": +region = region_info.RegionInfo.get("eu-west-1") +# Access attributes: +region.s3_static_website_endpoint # s3-website-eu-west-1.amazonaws.com +region.service_principal("logs.amazonaws.com") +``` +The `RegionInfo` layer is built on top of the Low-Level API, which is described +below and can be used to register additional data, including user-defined facts +that are not available through the `RegionInfo` interface. +### Low-Level API +This library offers a primitive database of such information so that CDK +constructs can easily access regional information. The `FactName` class provides +a list of known fact names, which can then be used with the `RegionInfo` to +retrieve a particular value: +```python +code_deploy_principal = region_info.Fact.find("us-east-1", region_info.FactName.service_principal("codedeploy.amazonaws.com")) +# => codedeploy.us-east-1.amazonaws.com +static_website = region_info.Fact.find("ap-northeast-1", region_info.FactName.S3_STATIC_WEBSITE_ENDPOINT) +``` +## Supplying new or missing information +As new regions are released, it might happen that a particular fact you need is +missing from the library. In such cases, the `Fact.register` method can be used +to inject FactName into the database: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact()) +``` +## Overriding incorrect information +In the event information provided by the library is incorrect, it can be +overridden using the same `Fact.register` method demonstrated above, simply +adding an extra boolean argument: +```python +@jsii.implements(region_info.IFact) +class MyFact: +region_info.Fact.register(MyFact(), True) +``` +If you happen to have stumbled upon incorrect data built into this library, it +is always a good idea to report your findings in a [GitHub issue](https://github.com/aws/aws-cdk/issues), so we can fix + +%prep +%autosetup -n aws-cdk.region-info-2.73.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-aws-cdk.region-info -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2.73.0-1 +- Package Spec generated |