awspec 1.32.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fda6baa9048249f77fa2fbc686a010ce8c64f9a2cc950707d6dacb99c2a352d
-  data.tar.gz: 9b52e0bd5e2d586207a4be29d37321158f037af215615ce791797e43cd118569
+  metadata.gz: d65a2f5aea6df138e2c8ddef3a36092fc2760f40086c4129ca4f639281b83e52
+  data.tar.gz: d9c213638e77e674dd5fd8b08648ec52956855285253330db732877cd40350ff
 SHA512:
-  metadata.gz: 4fcf1543ec18e1fe32468e48d20df072a5a53e1ef90394b451e4a383f438d49c167ba3a041073a0a118ffd46bd031ca547583732ec9d0254fb806f711f72d546
-  data.tar.gz: 7b6b59e791056334e52ad28da2ab62cf95cd7703e3e026a82d518ec0b1f1017c1aa7434ed1cb568879a544ab09bdb14f7cc0dbd3cd051df21f02a529e83f7286
+  metadata.gz: e7972b92325855e58d1c950192b49d477c2d913251c4577371b9f0a2ff593c56a839472cd42c44295562aaef5d9b74445392de9c8fe06ddd4c676962b425ca0f
+  data.tar.gz: 99d9f6df0b85b122550f4c07dfcfd2544a1ddb2a8bf17fc09588f53653a086d6caf851ca78663149a130da766e11afdf2ae6e3210987b0443608f09003122457

data/.github/release.yml

@@ -0,0 +1,4 @@
+changelog:
+  exclude:
+    labels:
+      - tagpr

data/.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:
@@ -13,16 +13,16 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
       with:
-        ruby-version: 3.1
+        ruby-version: ruby
         bundler-cache: true
 
     - name: Run rubocop
-      uses: reviewdog/action-rubocop@v1
+      uses: reviewdog/action-rubocop@a434f50eaae1589b90edcb14cabf70555571577a # v1.11.0
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         reporter: github-pr-review
@@ -46,10 +46,10 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true

data/.github/workflows/doc.yml

@@ -12,18 +12,18 @@ jobs:
       DISABLE_AWS_CLIENT_CHECK: true
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
       with:
-        ruby-version: '2.7'
+        ruby-version: ruby
         bundler-cache: true
 
     - name: Generate document
       run: bundle exec bin/toolbox docgen > doc/resource_types.md
 
-    - uses: EndBug/add-and-commit@v7
+    - uses: EndBug/add-and-commit@8c12ff729a98cfbcd3fe38b49f55eceb98a5ec02 # v7.5.0
       with:
         default_author: github_actions
         add: 'doc/resource_types.md'

data/.github/workflows/tagpr.yml

@@ -0,0 +1,58 @@
+name: tagpr
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tagpr:
+    runs-on: ubuntu-latest
+    outputs:
+      tagpr-tag: ${{ steps.run-tagpr.outputs.tag }}
+    permissions:
+      contents: write
+      pull-requests: write
+      issues: write
+      packages: write
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Check out source code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - id: run-tagpr
+        name: Run tagpr
+        uses: Songmu/tagpr@9c294c8b7b1815a5f3b7c61d6ee6aa50ac25b030 # v1.8.4
+
+  release:
+    needs: tagpr
+    if: needs.tagpr.outputs.tagpr-tag != ''
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+      id-token: write
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Check out source code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - name: release gem
+        uses: rubygems/release-gem@9fc8c0f9a461e67716cde28f188b9a5c029333a8 # v1

data/.rubocop.yml

@@ -21,6 +21,7 @@ Lint/DuplicateMethods:
     - 'lib/awspec/type/eks_nodegroup.rb'
     - 'lib/awspec/type/resource_base.rb'
     - 'lib/awspec/type/wafv2_ip_set.rb'
+    - 'lib/awspec/type/wafv2_web_acl.rb'
 
 Lint/ErbNewArguments:
   Enabled: false

data/.tagpr

@@ -0,0 +1,35 @@
+# config file for the tagpr in git config format
+# The tagpr generates the initial configuration, which you can rewrite to suit your environment.
+# CONFIGURATIONS:
+#   tagpr.releaseBranch
+#       Generally, it is "main." It is the branch for releases. The pcpr tracks this branch,
+#       creates or updates a pull request as a release candidate, or tags when they are merged.
+#
+#   tagpr.versionFile
+#       Versioning file containing the semantic version needed to be updated at release.
+#       It will be synchronized with the "git tag".
+#       Often this is a meta-information file such as gemspec, setup.cfg, package.json, etc.
+#       Sometimes the source code file, such as version.go or Bar.pm, is used.
+#       If you do not want to use versioning files but only git tags, specify the "-" string here.
+#       You can specify multiple version files by comma separated strings.
+#
+#   tagpr.vPrefix
+#       Flag whether or not v-prefix is added to semver when git tagging. (e.g. v1.2.3 if true)
+#       This is only a tagging convention, not how it is described in the version file.
+#
+#   tagpr.changelog (Optional)
+#       Flag whether or not changelog is added or changed during the release.
+#
+#   tagpr.command (Optional)
+#       Command to change files just before release.
+#
+#   tagpr.tmplate (Optional)
+#       Pull request template in go template format
+#
+#   tagpr.release (Optional)
+#       GitHub Release creation behavior after tagging [true, draft, false]
+#       If this value is not set, the release is to be created.
+[tagpr]
+	vPrefix = true
+	releaseBranch = main
+	versionFile = lib/awspec/version.rb

data/CHANGELOG.md

@@ -0,0 +1,98 @@
+# Changelog
+
+## [v1.34.0](https://github.com/k1LoW/awspec/compare/v1.33.0...v1.34.0) - 2025-10-18
+- Add support for aws backup rules (under backup plan) by @endemics in https://github.com/k1LoW/awspec/pull/605
+- feat: setup tagpr by @k1LoW in https://github.com/k1LoW/awspec/pull/606
+
+## [v1.33.0](https://github.com/k1LoW/awspec/compare/v1.32.0...v1.33.0) - 2025-08-10
+- Add wafv2_web_acl resource by @alpineriveredge in https://github.com/k1LoW/awspec/pull/600
+- Add type backup (new PR - no copyright headers) by @endemics in https://github.com/k1LoW/awspec/pull/601
+- Add tag support for DB and Global clusters by @alpineriveredge in https://github.com/k1LoW/awspec/pull/603
+- Make transfer_server searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/604
+
+## [v1.32.0](https://github.com/k1LoW/awspec/compare/v1.31.0...v1.32.0) - 2025-01-28
+- Add codepipeline resource by @alpineriveredge in https://github.com/k1LoW/awspec/pull/592
+- Add wafv2_ip_set resource by @alpineriveredge in https://github.com/k1LoW/awspec/pull/597
+- Fix find vpc_endpoint by Name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/598
+
+## [v1.31.0](https://github.com/k1LoW/awspec/compare/v1.30.0...v1.31.0) - 2025-01-22
+- Enhance codebuild resource by @alpineriveredge in https://github.com/k1LoW/awspec/pull/591
+- fix: Drop support for Ruby 2.x by @k1LoW in https://github.com/k1LoW/awspec/pull/596
+- Fix finding Gateway VPC Endpoints by id by @alexjfisher in https://github.com/k1LoW/awspec/pull/595
+
+## [v1.30.0](https://github.com/k1LoW/awspec/compare/v1.29.3...v1.30.0) - 2024-04-16
+- Make `transit_gateway` `have_attachment` work with names by @alexjfisher in https://github.com/k1LoW/awspec/pull/586
+- Add managed_prefix_list resource by @alpineriveredge in https://github.com/k1LoW/awspec/pull/587
+
+## [v1.29.3](https://github.com/k1LoW/awspec/compare/v1.29.2...v1.29.3) - 2024-01-04
+- Added pagination support to ssm_parameter by @anjo-swe in https://github.com/k1LoW/awspec/pull/583
+
+## [v1.29.2](https://github.com/k1LoW/awspec/compare/v1.29.1...v1.29.2) - 2023-04-08
+- Add support for a custom aws endpoint by @sverch in https://github.com/k1LoW/awspec/pull/580
+
+## [v1.29.1](https://github.com/k1LoW/awspec/compare/v1.29.0...v1.29.1) - 2023-03-21
+- Make network_interface searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/582
+
+## [v1.29.0](https://github.com/k1LoW/awspec/compare/v1.28.2...v1.29.0) - 2023-03-18
+- Make 'nat_gateway have_eip' searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/576
+- Fix ECR Repository document by @alpineriveredge in https://github.com/k1LoW/awspec/pull/577
+- Add policy_document to IAM Policy by @alpineriveredge in https://github.com/k1LoW/awspec/pull/578
+- Fix ALB & NLB have_subnet by @alpineriveredge in https://github.com/k1LoW/awspec/pull/579
+- [BREAKING] Drop 2.1 2.2 from supported Ruby versions / Add 3.2 by @k1LoW in https://github.com/k1LoW/awspec/pull/581
+- Update doc for ecs_service for using non-default cluster by @jedipunkz in https://github.com/k1LoW/awspec/pull/508
+
+## [v1.28.2](https://github.com/k1LoW/awspec/compare/v1.28.1...v1.28.2) - 2022-10-24
+- Add vpc_endpoints attributes by @alpineriveredge in https://github.com/k1LoW/awspec/pull/571
+- Add Elastic IP attributes by @alpineriveredge in https://github.com/k1LoW/awspec/pull/572
+- s3_bucket - fixed documentation for prefix in have_lifecycle_rule by @anjo-swe in https://github.com/k1LoW/awspec/pull/573
+- Make 'vpc_endponts have_subnet' testable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/574
+- Make vpn_gateway searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/575
+
+## [v1.28.1](https://github.com/k1LoW/awspec/compare/v1.28.0...v1.28.1) - 2022-08-29
+- Fix vpc_endpoints document by @alpineriveredge in https://github.com/k1LoW/awspec/pull/569
+- Allow Tags of CloudFormation Stack by @alpineriveredge in https://github.com/k1LoW/awspec/pull/570
+
+## [v1.28.0](https://github.com/k1LoW/awspec/compare/v1.27.1...v1.28.0) - 2022-08-16
+- Add RDS DB Cluster & Global Cluster by @alpineriveredge in https://github.com/k1LoW/awspec/pull/566
+
+## [v1.27.1](https://github.com/k1LoW/awspec/compare/v1.27.0...v1.27.1) - 2022-07-18
+- Make eip searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/565
+
+## [v1.27.0](https://github.com/k1LoW/awspec/compare/v1.26.0...v1.27.0) - 2022-07-03
+- Add RDS Proxy by @alpineriveredge in https://github.com/k1LoW/awspec/pull/564
+
+## [v1.26.0](https://github.com/k1LoW/awspec/compare/v1.25.2...v1.26.0) - 2022-06-06
+- Use parallel.gem by @k1LoW in https://github.com/k1LoW/awspec/pull/557
+- Add transfer_server type by @andoniaf in https://github.com/k1LoW/awspec/pull/558
+- Make vpc_endpoint searchable by name by @alpineriveredge in https://github.com/k1LoW/awspec/pull/561
+- require octorelease when not CI by @k1LoW in https://github.com/k1LoW/awspec/pull/562
+
+## [v1.25.2](https://github.com/k1LoW/awspec/compare/v1.25.1...v1.25.2) - 2022-01-25
+- Support Ruby 3.0.x by @k1LoW in https://github.com/k1LoW/awspec/pull/554
+- Support Ruby 3.1.x by @k1LoW in https://github.com/k1LoW/awspec/pull/555
+- Update rubocop by @k1LoW in https://github.com/k1LoW/awspec/pull/556
+
+## [v1.25.1](https://github.com/k1LoW/awspec/compare/v1.25.0...v1.25.1) - 2021-10-08
+- Fix: undefined method `by_cidr' by @k1LoW in https://github.com/k1LoW/awspec/pull/550
+
+## [v1.25.0](https://github.com/k1LoW/awspec/compare/v1.24.4...v1.25.0) - 2021-09-04
+- Bugfix/issue 264 by @glasswalk3r in https://github.com/k1LoW/awspec/pull/538
+- Added missing SNS specs by @glasswalk3r in https://github.com/k1LoW/awspec/pull/547
+- Bugfix/issue 527 by @glasswalk3r in https://github.com/k1LoW/awspec/pull/548
+
+## [v1.24.4](https://github.com/k1LoW/awspec/compare/v1.24.3...v1.24.4) - 2021-08-09
+- Use GitHub Actions by @k1LoW in https://github.com/k1LoW/awspec/pull/541
+- Update rubocop by @k1LoW in https://github.com/k1LoW/awspec/pull/542
+- refactor: faster EC2 instance search by @glasswalk3r in https://github.com/k1LoW/awspec/pull/535
+- Feature/issue 407 by @glasswalk3r in https://github.com/k1LoW/awspec/pull/543
+- Feature/metric filter pattern support by @JinhuaK in https://github.com/k1LoW/awspec/pull/544
+
+## [v1.24.3](https://github.com/k1LoW/awspec/compare/v1.24.2...v1.24.3) - 2021-07-12
+- Added elasticache spec generator by @inokappa in https://github.com/k1LoW/awspec/pull/540
+
+## [v1.24.2](https://github.com/k1LoW/awspec/compare/v1.24.1...v1.24.2) - 2021-07-04
+- fix: properly handling EC2 errors by @glasswalk3r in https://github.com/k1LoW/awspec/pull/534
+- Bugfix/issue 325 by @glasswalk3r in https://github.com/k1LoW/awspec/pull/537
+
+## [v1.24.1](https://github.com/k1LoW/awspec/compare/v1.24.0...v1.24.1) - 2021-05-08
+- Fixed a bug when a bucket was placed in us-east-1 by @soruma in https://github.com/k1LoW/awspec/pull/533

data/doc/_resource_types/backup_plan.md

@@ -0,0 +1,7 @@
+### exist
+
+```ruby
+describe backup_plan('my-backup-plan') do
+  it { should exist }
+end
+```

data/doc/_resource_types/backup_selection.md

@@ -0,0 +1,7 @@
+### exist
+
+```ruby
+describe backup_selection('my-backup-selection') do
+  it { should exist }
+end
+```

data/doc/_resource_types/backup_vault.md

@@ -0,0 +1,35 @@
+### exist
+
+```ruby
+describe backup_vault('my-backup-vault') do
+  it { should exist }
+end
+```
+
+### its(:backup_vault_name), its(:backup_vault_arn), its(:vault_type), its(:vault_state), its(:creation_date), its(:encryption_key_arn), its(:creator_request_id), its(:number_of_recovery_points), its(:locked), its(:min_retention_days), its(:max_retention_days), its(:lock_date)
+
+```ruby
+describe backup_vault('my-backup-vault') do
+  it { should exist }
+  its(:locked) { should be true }
+  its(:lock_date) { should be < (Time.now - 60*60*24*30) }
+  its(:vault_state) { should eq "AVAILABLE" }
+  its(:vault_type) { should eq "BACKUP_VAULT" }
+  its(:min_retention_days) { should be 7 }
+  its(:max_retention_days) { should be 35 }
+  its(:lock_date) { should eq(Time.new(2024, 10, 4, 9, 00, 00, '+00:00')) }
+  its(:encryption_key_arn) { should eq 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab' }
+  its(:number_of_recovery_points) { should be > 100 }
+end
+
+describe backup_vault('my-airgapped-vault') do
+  it { should exist }
+  its(:locked) { should be false }
+  its(:creation_date) { should be > Time.new(2016, 4, 4, 9, 00, 00, '+00:00') }
+  its(:vault_state) { should eq "AVAILABLE" }
+  its(:vault_type) { should eq "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" }
+  its(:backup_vault_arn) { should match /:111122223333:/ }
+  its(:backup_vault_arn) { should match /:us-west-2:/ }
+  its(:number_of_recovery_points) { should be > 10 }
+end
+```

data/doc/_resource_types/rds_db_cluster.md

@@ -45,3 +45,11 @@ describe rds_db_cluster('my-rds-db-cluster') do
   it { should have_security_group('my-db-sg') }
 end
 ```
+
+### have_tag
+
+```ruby
+describe rds_db_cluster('my-rds-db-cluster') do
+  it { should have_tag('env').value('dev') }
+end
+```

data/doc/_resource_types/rds_global_cluster.md

@@ -35,3 +35,11 @@ describe rds_global_cluster('my-rds-global-cluster') do
   it { should have_cluster_member('arn:aws:rds:ap-northeast-3:123456789012:cluster:my-secondary-cluster').is_writer(false) }
 end
 ```
+
+### have_tag
+
+```ruby
+describe rds_global_cluster('my-rds-global-cluster') do
+  it { should have_tag('env').value('dev') }
+end
+```

data/doc/_resource_types/transfer_server.md

@@ -4,6 +4,10 @@
 describe transfer_server('s-4dc0a424f0154fa89') do
   it { should exist }
 end
+
+describe transfer_server('my-transfer-server') do
+  it { should exist }
+end
 ```
 
 ### be_offline, be_online, be_starting, be_stopping, be_start_failed, be_stop_failed

data/doc/_resource_types/wafv2_ip_set.md

@@ -3,7 +3,11 @@
 You can set `scope` to CLOUDFRONT or REGIONAL ( default: `REGIONAL` ).
 
 ```ruby
-describe wafv2_ip_set('my-ip-set'), scope: 'REGIONAL' do
+describe wafv2_ip_set('my-wafv2-ip-set'), scope: 'REGIONAL' do
+  it { should exist }
+end
+
+describe wafv2_ip_set('my-wafv2-ip-set'), scope: 'CLOUDFRONT', region: 'us-east-1' do
   it { should exist }
 end
 ```
@@ -11,7 +15,7 @@ end
 ### have_ip_address
 
 ```ruby
-describe wafv2_ip_set('my-ip-set'), scope: 'REGIONAL' do
+describe wafv2_ip_set('my-wafv2-ip-set'), scope: 'REGIONAL' do
   it { should have_ip_address('10.0.0.0/32') }
 end
 ```

data/doc/_resource_types/wafv2_web_acl.md

@@ -0,0 +1,25 @@
+### exist
+
+You can set `scope` to CLOUDFRONT or REGIONAL ( default: `REGIONAL` ).
+
+```ruby
+describe wafv2_web_acl('my-wafv2-web-acl'), scope: 'REGIONAL' do
+  it { should exist }
+  its(:default_action) { should eq 'ALLOW' }
+end
+
+describe wafv2_web_acl('my-wafv2-web-acl'), scope: 'CLOUDFRONT', region: 'us-east-1' do
+  it { should exist }
+  its(:default_action) { should eq 'ALLOW' }
+end
+```
+
+### have_rule
+
+```ruby
+describe wafv2_web_acl('my-wafv2-web-acl'), scope: 'REGIONAL' do
+  it { should have_rule('AWS-AWSManagedRulesCommonRuleSet') }
+  it { should have_rule('AWS-AWSManagedRulesKnownBadInputsRuleSet').order(1) }
+  it { should have_rule('AWS-AWSManagedRulesLinuxRuleSet').order(2).override_action('NONE') }
+end
+```

data/doc/contributing.md

@@ -4,10 +4,10 @@
 
 1. Create your feature branch (`git checkout -b add-type-redshift`)
 2. Generate template files (`bundle exec bin/toolbox template redshift`)
-3. Fill files with code.
+3. Fill files with code and test your code regularly (`bundle exec rspec spec/type/redshift_spec.rb`)
 4. `bundle update` to update gems.
 5. Generate [doc/resource_types.md](resource_types.md) (`bundle exec rake generate_docs`)
-6. Run test (`bundle exec rake spec`)
+6. Run all tests (`bundle exec rake spec`)
 7. Push to the branch (`git push origin add-type-redshift`)
 8. Create a new Pull Request