@aws-cdk/cloud-assembly-schema 37.0.0 → 38.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/.jsii +303 -594
  2. package/lib/assets/aws-destination.d.ts +12 -0
  3. package/lib/assets/aws-destination.js +1 -1
  4. package/lib/cloud-assembly/artifact-schema.d.ts +24 -0
  5. package/lib/cloud-assembly/artifact-schema.js +1 -1
  6. package/lib/cloud-assembly/context-queries.d.ts +35 -138
  7. package/lib/cloud-assembly/context-queries.js +1 -1
  8. package/lib/manifest.d.ts +5 -0
  9. package/lib/manifest.js +23 -2
  10. package/package.json +1 -1
  11. package/schema/assets.schema.json +10 -0
  12. package/schema/cloud-assembly.schema.json +173 -73
package/schema/cloud-assembly.schema.json CHANGED
@@ -369,6 +369,11 @@
369
369
  "description": "External ID to use when assuming role for cloudformation deployments (Default - No external ID)",
370
370
  "type": "string"
371
371
  },
372
+ "assumeRoleAdditionalOptions": {
373
+ "description": "Additional options to pass to STS when assuming the role.\n\n- `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead. (Default - No additional options.)",
374
+ "type": "object",
375
+ "additionalProperties": {}
376
+ },
372
377
  "cloudFormationExecutionRoleArn": {
373
378
  "description": "The role that is passed to CloudFormation to execute the change set (Default - No role is passed (currently assumed role/credentials are used))",
374
379
  "type": "string"
@@ -410,6 +415,11 @@
410
415
  "description": "External ID to use when assuming the bootstrap role (Default - No external ID)",
411
416
  "type": "string"
412
417
  },
418
+ "assumeRoleAdditionalOptions": {
419
+ "description": "Additional options to pass to STS when assuming the role.\n\n- `RoleArn` should not be used. Use the dedicated `arn` property instead.\n- `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead. (Default - No additional options.)",
420
+ "type": "object",
421
+ "additionalProperties": {}
422
+ },
413
423
  "requiresBootstrapStackVersion": {
414
424
  "description": "Version of bootstrap stack required to use this role (Default - No bootstrap stack required)",
415
425
  "type": "number"
@@ -555,18 +565,6 @@
555
565
  "description": "Query to AMI context provider",
556
566
  "type": "object",
557
567
  "properties": {
558
- "account": {
559
- "description": "Account to query",
560
- "type": "string"
561
- },
562
- "region": {
563
- "description": "Region to query",
564
- "type": "string"
565
- },
566
- "lookupRoleArn": {
567
- "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
568
- "type": "string"
569
- },
570
568
  "owners": {
571
569
  "description": "Owners to DescribeImages call (Default - All owners)",
572
570
  "type": "array",
@@ -583,6 +581,27 @@
583
581
  "type": "string"
584
582
  }
585
583
  }
584
+ },
585
+ "account": {
586
+ "description": "Query account",
587
+ "type": "string"
588
+ },
589
+ "region": {
590
+ "description": "Query region",
591
+ "type": "string"
592
+ },
593
+ "lookupRoleArn": {
594
+ "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
595
+ "type": "string"
596
+ },
597
+ "lookupRoleExternalId": {
598
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
599
+ "type": "string"
600
+ },
601
+ "assumeRoleAdditionalOptions": {
602
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
603
+ "type": "object",
604
+ "additionalProperties": {}
586
605
  }
587
606
  },
588
607
  "required": [
@@ -606,6 +625,15 @@
606
625
  "lookupRoleArn": {
607
626
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
608
627
  "type": "string"
628
+ },
629
+ "lookupRoleExternalId": {
630
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
631
+ "type": "string"
632
+ },
633
+ "assumeRoleAdditionalOptions": {
634
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
635
+ "type": "object",
636
+ "additionalProperties": {}
609
637
  }
610
638
  },
611
639
  "required": [
@@ -617,6 +645,19 @@
617
645
  "description": "Query to hosted zone context provider",
618
646
  "type": "object",
619
647
  "properties": {
648
+ "domainName": {
649
+ "description": "The domain name e.g. example.com to lookup",
650
+ "type": "string"
651
+ },
652
+ "privateZone": {
653
+ "description": "True if the zone you want to find is a private hosted zone",
654
+ "default": false,
655
+ "type": "boolean"
656
+ },
657
+ "vpcId": {
658
+ "description": "The VPC ID to that the private zone must be associated with\n\nIf you provide VPC ID and privateZone is false, this will return no results\nand raise an error. (Default - Required if privateZone=true)",
659
+ "type": "string"
660
+ },
620
661
  "account": {
621
662
  "description": "Query account",
622
663
  "type": "string"
@@ -629,18 +670,14 @@
629
670
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
630
671
  "type": "string"
631
672
  },
632
- "domainName": {
633
- "description": "The domain name e.g. example.com to lookup",
673
+ "lookupRoleExternalId": {
674
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
634
675
  "type": "string"
635
676
  },
636
- "privateZone": {
637
- "description": "True if the zone you want to find is a private hosted zone",
638
- "default": false,
639
- "type": "boolean"
640
- },
641
- "vpcId": {
642
- "description": "The VPC ID to that the private zone must be associated with\n\nIf you provide VPC ID and privateZone is false, this will return no results\nand raise an error. (Default - Required if privateZone=true)",
643
- "type": "string"
677
+ "assumeRoleAdditionalOptions": {
678
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
679
+ "type": "object",
680
+ "additionalProperties": {}
644
681
  }
645
682
  },
646
683
  "required": [
@@ -653,6 +690,10 @@
653
690
  "description": "Query to SSM Parameter Context Provider",
654
691
  "type": "object",
655
692
  "properties": {
693
+ "parameterName": {
694
+ "description": "Parameter name to query",
695
+ "type": "string"
696
+ },
656
697
  "account": {
657
698
  "description": "Query account",
658
699
  "type": "string"
@@ -665,9 +706,14 @@
665
706
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
666
707
  "type": "string"
667
708
  },
668
- "parameterName": {
669
- "description": "Parameter name to query",
709
+ "lookupRoleExternalId": {
710
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
670
711
  "type": "string"
712
+ },
713
+ "assumeRoleAdditionalOptions": {
714
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
715
+ "type": "object",
716
+ "additionalProperties": {}
671
717
  }
672
718
  },
673
719
  "required": [
@@ -680,18 +726,6 @@
680
726
  "description": "Query input for looking up a VPC",
681
727
  "type": "object",
682
728
  "properties": {
683
- "account": {
684
- "description": "Query account",
685
- "type": "string"
686
- },
687
- "region": {
688
- "description": "Query region",
689
- "type": "string"
690
- },
691
- "lookupRoleArn": {
692
- "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
693
- "type": "string"
694
- },
695
729
  "filter": {
696
730
  "description": "Filters to apply to the VPC\n\nFilter parameters are the same as passed to DescribeVpcs.",
697
731
  "type": "object",
@@ -711,6 +745,27 @@
711
745
  "returnVpnGateways": {
712
746
  "description": "Whether to populate the `vpnGatewayId` field of the `VpcContextResponse`,\nwhich contains the VPN Gateway ID, if one exists. You can explicitly\ndisable this in order to avoid the lookup if you know the VPC does not have\na VPN Gatway attached. (Default true)",
713
747
  "type": "boolean"
748
+ },
749
+ "account": {
750
+ "description": "Query account",
751
+ "type": "string"
752
+ },
753
+ "region": {
754
+ "description": "Query region",
755
+ "type": "string"
756
+ },
757
+ "lookupRoleArn": {
758
+ "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
759
+ "type": "string"
760
+ },
761
+ "lookupRoleExternalId": {
762
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
763
+ "type": "string"
764
+ },
765
+ "assumeRoleAdditionalOptions": {
766
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
767
+ "type": "object",
768
+ "additionalProperties": {}
714
769
  }
715
770
  },
716
771
  "required": [
@@ -723,6 +778,10 @@
723
778
  "description": "Query to endpoint service context provider",
724
779
  "type": "object",
725
780
  "properties": {
781
+ "serviceName": {
782
+ "description": "Query service name",
783
+ "type": "string"
784
+ },
726
785
  "account": {
727
786
  "description": "Query account",
728
787
  "type": "string"
@@ -735,9 +794,14 @@
735
794
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
736
795
  "type": "string"
737
796
  },
738
- "serviceName": {
739
- "description": "Query service name",
797
+ "lookupRoleExternalId": {
798
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
740
799
  "type": "string"
800
+ },
801
+ "assumeRoleAdditionalOptions": {
802
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
803
+ "type": "object",
804
+ "additionalProperties": {}
741
805
  }
742
806
  },
743
807
  "required": [
@@ -750,18 +814,6 @@
750
814
  "description": "Query input for looking up a load balancer",
751
815
  "type": "object",
752
816
  "properties": {
753
- "account": {
754
- "description": "Query account",
755
- "type": "string"
756
- },
757
- "region": {
758
- "description": "Query region",
759
- "type": "string"
760
- },
761
- "lookupRoleArn": {
762
- "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
763
- "type": "string"
764
- },
765
817
  "loadBalancerType": {
766
818
  "$ref": "#/definitions/LoadBalancerType",
767
819
  "description": "Filter load balancers by their type"
@@ -776,6 +828,27 @@
776
828
  "items": {
777
829
  "$ref": "#/definitions/Tag"
778
830
  }
831
+ },
832
+ "account": {
833
+ "description": "Query account",
834
+ "type": "string"
835
+ },
836
+ "region": {
837
+ "description": "Query region",
838
+ "type": "string"
839
+ },
840
+ "lookupRoleArn": {
841
+ "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
842
+ "type": "string"
843
+ },
844
+ "lookupRoleExternalId": {
845
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
846
+ "type": "string"
847
+ },
848
+ "assumeRoleAdditionalOptions": {
849
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
850
+ "type": "object",
851
+ "additionalProperties": {}
779
852
  }
780
853
  },
781
854
  "required": [
@@ -796,18 +869,6 @@
796
869
  "description": "Query input for looking up a load balancer listener",
797
870
  "type": "object",
798
871
  "properties": {
799
- "account": {
800
- "description": "Query account",
801
- "type": "string"
802
- },
803
- "region": {
804
- "description": "Query region",
805
- "type": "string"
806
- },
807
- "lookupRoleArn": {
808
- "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
809
- "type": "string"
810
- },
811
872
  "listenerArn": {
812
873
  "description": "Find by listener's arn (Default - does not find by listener arn)",
813
874
  "type": "string"
@@ -842,6 +903,27 @@
842
903
  "items": {
843
904
  "$ref": "#/definitions/Tag"
844
905
  }
906
+ },
907
+ "account": {
908
+ "description": "Query account",
909
+ "type": "string"
910
+ },
911
+ "region": {
912
+ "description": "Query region",
913
+ "type": "string"
914
+ },
915
+ "lookupRoleArn": {
916
+ "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
917
+ "type": "string"
918
+ },
919
+ "lookupRoleExternalId": {
920
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
921
+ "type": "string"
922
+ },
923
+ "assumeRoleAdditionalOptions": {
924
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
925
+ "type": "object",
926
+ "additionalProperties": {}
845
927
  }
846
928
  },
847
929
  "required": [
@@ -854,6 +936,18 @@
854
936
  "description": "Query input for looking up a security group",
855
937
  "type": "object",
856
938
  "properties": {
939
+ "securityGroupId": {
940
+ "description": "Security group id (Default - None)",
941
+ "type": "string"
942
+ },
943
+ "securityGroupName": {
944
+ "description": "Security group name (Default - None)",
945
+ "type": "string"
946
+ },
947
+ "vpcId": {
948
+ "description": "VPC ID (Default - None)",
949
+ "type": "string"
950
+ },
857
951
  "account": {
858
952
  "description": "Query account",
859
953
  "type": "string"
@@ -866,17 +960,14 @@
866
960
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
867
961
  "type": "string"
868
962
  },
869
- "securityGroupId": {
870
- "description": "Security group id (Default - None)",
871
- "type": "string"
872
- },
873
- "securityGroupName": {
874
- "description": "Security group name (Default - None)",
963
+ "lookupRoleExternalId": {
964
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
875
965
  "type": "string"
876
966
  },
877
- "vpcId": {
878
- "description": "VPC ID (Default - None)",
879
- "type": "string"
967
+ "assumeRoleAdditionalOptions": {
968
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
969
+ "type": "object",
970
+ "additionalProperties": {}
880
971
  }
881
972
  },
882
973
  "required": [
@@ -888,6 +979,10 @@
888
979
  "description": "Query input for looking up a KMS Key",
889
980
  "type": "object",
890
981
  "properties": {
982
+ "aliasName": {
983
+ "description": "Alias name used to search the Key",
984
+ "type": "string"
985
+ },
891
986
  "account": {
892
987
  "description": "Query account",
893
988
  "type": "string"
@@ -900,9 +995,14 @@
900
995
  "description": "The ARN of the role that should be used to look up the missing values (Default - None)",
901
996
  "type": "string"
902
997
  },
903
- "aliasName": {
904
- "description": "Alias name used to search the Key",
998
+ "lookupRoleExternalId": {
999
+ "description": "The ExternalId that needs to be supplied while assuming this role (Default - No ExternalId will be supplied)",
905
1000
  "type": "string"
1001
+ },
1002
+ "assumeRoleAdditionalOptions": {
1003
+ "description": "Additional options to pass to STS when assuming the lookup role.\n\n- `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.\n- `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead. (Default - No additional options.)",
1004
+ "type": "object",
1005
+ "additionalProperties": {}
906
1006
  }
907
1007
  },
908
1008
  "required": [