aws-sdk-cloudhsmv2 1.60.0 → 1.61.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudhsmv2/client.rb +238 -25
- data/lib/aws-sdk-cloudhsmv2/client_api.rb +73 -1
- data/lib/aws-sdk-cloudhsmv2/endpoints.rb +42 -0
- data/lib/aws-sdk-cloudhsmv2/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-cloudhsmv2/types.rb +140 -13
- data/lib/aws-sdk-cloudhsmv2.rb +1 -1
- data/sig/client.rbs +34 -0
- data/sig/types.rbs +35 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8e598aa0e948de93f40a8423c727a2c98c5449f6d842a711b63bbc14df72982e
|
4
|
+
data.tar.gz: 97d3ede72cfddcda9e8340f1fa8903b7b8628e7b0116c3794705a4bf98bf7d17
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7ee05ce38fc94da52ed8b1600858e2fda8ef3a1ce3cf380524789a738e60f40e8b271b0c2f36e9d57f1830647eb15bd2a74a35658aa417d3af5dcda3fddadb87
|
7
|
+
data.tar.gz: 687ea8adc606d100ca5f0ea33bd06be572b1e5b9bd8ddd31d51f330ba313310f77da1e9ba9bcb86252f3dda811f3916cb9511308781f31a089f7c8d044a0ca13
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.61.0 (2024-06-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added 3 new APIs to support backup sharing: GetResourcePolicy, PutResourcePolicy, and DeleteResourcePolicy. Added BackupArn to the output of the DescribeBackups API. Added support for BackupArn in the CreateCluster API.
|
8
|
+
|
4
9
|
1.60.0 (2024-06-25)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.61.0
|
@@ -423,7 +423,10 @@ module Aws::CloudHSMV2
|
|
423
423
|
|
424
424
|
# @!group API Operations
|
425
425
|
|
426
|
-
# Copy an
|
426
|
+
# Copy an CloudHSM cluster backup to a different region.
|
427
|
+
#
|
428
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
429
|
+
# CloudHSM backup in a different Amazon Web Services account.
|
427
430
|
#
|
428
431
|
# @option params [required, String] :destination_region
|
429
432
|
# The AWS region that will contain your copied CloudHSM cluster backup.
|
@@ -470,7 +473,11 @@ module Aws::CloudHSMV2
|
|
470
473
|
req.send_request(options)
|
471
474
|
end
|
472
475
|
|
473
|
-
# Creates a new
|
476
|
+
# Creates a new CloudHSM cluster.
|
477
|
+
#
|
478
|
+
# **Cross-account use:** Yes. To perform this operation with an CloudHSM
|
479
|
+
# backup in a different AWS account, specify the full backup ARN in the
|
480
|
+
# value of the SourceBackupId parameter.
|
474
481
|
#
|
475
482
|
# @option params [Types::BackupRetentionPolicy] :backup_retention_policy
|
476
483
|
# A policy that defines how the service retains backups.
|
@@ -480,9 +487,11 @@ module Aws::CloudHSMV2
|
|
480
487
|
# `hsm1.medium` and `hsm2m.medium`.
|
481
488
|
#
|
482
489
|
# @option params [String] :source_backup_id
|
483
|
-
# The identifier (ID)
|
484
|
-
# to restore
|
485
|
-
# cluster. To find the backup ID, use
|
490
|
+
# The identifier (ID) or the Amazon Resource Name (ARN) of the cluster
|
491
|
+
# backup to restore. Use this value to restore the cluster from a backup
|
492
|
+
# instead of creating a new cluster. To find the backup ID or ARN, use
|
493
|
+
# DescribeBackups. *If using a backup in another account, the full ARN
|
494
|
+
# must be supplied.*
|
486
495
|
#
|
487
496
|
# @option params [required, Array<String>] :subnet_ids
|
488
497
|
# The identifiers (IDs) of the subnets where you are creating the
|
@@ -512,7 +521,7 @@ module Aws::CloudHSMV2
|
|
512
521
|
# value: "BackupRetentionValue",
|
513
522
|
# },
|
514
523
|
# hsm_type: "HsmType", # required
|
515
|
-
# source_backup_id: "
|
524
|
+
# source_backup_id: "BackupArn",
|
516
525
|
# subnet_ids: ["SubnetId"], # required
|
517
526
|
# tag_list: [
|
518
527
|
# {
|
@@ -567,8 +576,11 @@ module Aws::CloudHSMV2
|
|
567
576
|
req.send_request(options)
|
568
577
|
end
|
569
578
|
|
570
|
-
# Creates a new hardware security module (HSM) in the specified
|
571
|
-
#
|
579
|
+
# Creates a new hardware security module (HSM) in the specified CloudHSM
|
580
|
+
# cluster.
|
581
|
+
#
|
582
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
583
|
+
# CloudHSM cluster in a different Amazon Web Service account.
|
572
584
|
#
|
573
585
|
# @option params [required, String] :cluster_id
|
574
586
|
# The identifier (ID) of the HSM's cluster. To find the cluster ID, use
|
@@ -616,9 +628,12 @@ module Aws::CloudHSMV2
|
|
616
628
|
req.send_request(options)
|
617
629
|
end
|
618
630
|
|
619
|
-
# Deletes a specified
|
620
|
-
#
|
621
|
-
#
|
631
|
+
# Deletes a specified CloudHSM backup. A backup can be restored up to 7
|
632
|
+
# days after the DeleteBackup request is made. For more information on
|
633
|
+
# restoring a backup, see RestoreBackup.
|
634
|
+
#
|
635
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
636
|
+
# CloudHSM backup in a different Amazon Web Services account.
|
622
637
|
#
|
623
638
|
# @option params [required, String] :backup_id
|
624
639
|
# The ID of the backup to be deleted. To find the ID of a backup, use
|
@@ -637,6 +652,7 @@ module Aws::CloudHSMV2
|
|
637
652
|
# @example Response structure
|
638
653
|
#
|
639
654
|
# resp.backup.backup_id #=> String
|
655
|
+
# resp.backup.backup_arn #=> String
|
640
656
|
# resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
|
641
657
|
# resp.backup.cluster_id #=> String
|
642
658
|
# resp.backup.create_timestamp #=> Time
|
@@ -661,11 +677,14 @@ module Aws::CloudHSMV2
|
|
661
677
|
req.send_request(options)
|
662
678
|
end
|
663
679
|
|
664
|
-
# Deletes the specified
|
680
|
+
# Deletes the specified CloudHSM cluster. Before you can delete a
|
665
681
|
# cluster, you must delete all HSMs in the cluster. To see if the
|
666
682
|
# cluster contains any HSMs, use DescribeClusters. To delete an HSM, use
|
667
683
|
# DeleteHsm.
|
668
684
|
#
|
685
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
686
|
+
# CloudHSM cluster in a different Amazon Web Services account.
|
687
|
+
#
|
669
688
|
# @option params [required, String] :cluster_id
|
670
689
|
# The identifier (ID) of the cluster that you are deleting. To find the
|
671
690
|
# cluster ID, use DescribeClusters.
|
@@ -729,6 +748,9 @@ module Aws::CloudHSMV2
|
|
729
748
|
# interface (ENI), or the ID of the HSM's ENI. You need to specify only
|
730
749
|
# one of these values. To find these values, use DescribeClusters.
|
731
750
|
#
|
751
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
752
|
+
# CloudHSM hsm in a different Amazon Web Services account.
|
753
|
+
#
|
732
754
|
# @option params [required, String] :cluster_id
|
733
755
|
# The identifier (ID) of the cluster that contains the HSM that you are
|
734
756
|
# deleting.
|
@@ -770,7 +792,46 @@ module Aws::CloudHSMV2
|
|
770
792
|
req.send_request(options)
|
771
793
|
end
|
772
794
|
|
773
|
-
#
|
795
|
+
# Deletes an CloudHSM resource policy. Deleting a resource policy will
|
796
|
+
# result in the resource being unshared and removed from any RAM
|
797
|
+
# resource shares. Deleting the resource policy attached to a backup
|
798
|
+
# will not impact any clusters created from that backup.
|
799
|
+
#
|
800
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
801
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
802
|
+
#
|
803
|
+
# @option params [String] :resource_arn
|
804
|
+
# Amazon Resource Name (ARN) of the resource from which the policy will
|
805
|
+
# be removed.
|
806
|
+
#
|
807
|
+
# @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
808
|
+
#
|
809
|
+
# * {Types::DeleteResourcePolicyResponse#resource_arn #resource_arn} => String
|
810
|
+
# * {Types::DeleteResourcePolicyResponse#policy #policy} => String
|
811
|
+
#
|
812
|
+
# @example Request syntax with placeholder values
|
813
|
+
#
|
814
|
+
# resp = client.delete_resource_policy({
|
815
|
+
# resource_arn: "CloudHsmArn",
|
816
|
+
# })
|
817
|
+
#
|
818
|
+
# @example Response structure
|
819
|
+
#
|
820
|
+
# resp.resource_arn #=> String
|
821
|
+
# resp.policy #=> String
|
822
|
+
#
|
823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteResourcePolicy AWS API Documentation
|
824
|
+
#
|
825
|
+
# @overload delete_resource_policy(params = {})
|
826
|
+
# @param [Hash] params ({})
|
827
|
+
def delete_resource_policy(params = {}, options = {})
|
828
|
+
req = build_request(:delete_resource_policy, params)
|
829
|
+
req.send_request(options)
|
830
|
+
end
|
831
|
+
|
832
|
+
# Gets information about backups of CloudHSM clusters. Lists either the
|
833
|
+
# backups you own or the backups shared with you when the Shared
|
834
|
+
# parameter is true.
|
774
835
|
#
|
775
836
|
# This is a paginated operation, which means that each response might
|
776
837
|
# contain only a subset of all the backups. When the response contains
|
@@ -779,6 +840,9 @@ module Aws::CloudHSMV2
|
|
779
840
|
# When you receive a response with no `NextToken` (or an empty or null
|
780
841
|
# value), that means there are no more backups to get.
|
781
842
|
#
|
843
|
+
# **Cross-account use:** Yes. Customers can describe backups in other
|
844
|
+
# Amazon Web Services accounts that are shared with them.
|
845
|
+
#
|
782
846
|
# @option params [String] :next_token
|
783
847
|
# The `NextToken` value that you received in the previous response. Use
|
784
848
|
# this value to get more backups.
|
@@ -809,6 +873,25 @@ module Aws::CloudHSMV2
|
|
809
873
|
# from the backup retention policy. `False` returns all backups with a
|
810
874
|
# backup retention policy defined at the cluster.
|
811
875
|
#
|
876
|
+
# @option params [Boolean] :shared
|
877
|
+
# Describe backups that are shared with you.
|
878
|
+
#
|
879
|
+
# <note markdown="1"> By default when using this option, the command returns backups that
|
880
|
+
# have been shared using a standard Resource Access Manager resource
|
881
|
+
# share. In order for a backup that was shared using the
|
882
|
+
# PutResourcePolicy command to be returned, the share must be promoted
|
883
|
+
# to a standard resource share using the RAM
|
884
|
+
# [PromoteResourceShareCreatedFromPolicy][1] API operation. For more
|
885
|
+
# information about sharing backups, see [ Working with shared
|
886
|
+
# backups][2] in the CloudHSM User Guide.
|
887
|
+
#
|
888
|
+
# </note>
|
889
|
+
#
|
890
|
+
#
|
891
|
+
#
|
892
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html
|
893
|
+
# [2]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html
|
894
|
+
#
|
812
895
|
# @option params [Boolean] :sort_ascending
|
813
896
|
# Designates whether or not to sort the return backups by ascending
|
814
897
|
# chronological order of generation.
|
@@ -828,6 +911,7 @@ module Aws::CloudHSMV2
|
|
828
911
|
# filters: {
|
829
912
|
# "Field" => ["String"],
|
830
913
|
# },
|
914
|
+
# shared: false,
|
831
915
|
# sort_ascending: false,
|
832
916
|
# })
|
833
917
|
#
|
@@ -835,6 +919,7 @@ module Aws::CloudHSMV2
|
|
835
919
|
#
|
836
920
|
# resp.backups #=> Array
|
837
921
|
# resp.backups[0].backup_id #=> String
|
922
|
+
# resp.backups[0].backup_arn #=> String
|
838
923
|
# resp.backups[0].backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
|
839
924
|
# resp.backups[0].cluster_id #=> String
|
840
925
|
# resp.backups[0].create_timestamp #=> Time
|
@@ -860,7 +945,7 @@ module Aws::CloudHSMV2
|
|
860
945
|
req.send_request(options)
|
861
946
|
end
|
862
947
|
|
863
|
-
# Gets information about
|
948
|
+
# Gets information about CloudHSM clusters.
|
864
949
|
#
|
865
950
|
# This is a paginated operation, which means that each response might
|
866
951
|
# contain only a subset of all the clusters. When the response contains
|
@@ -869,6 +954,9 @@ module Aws::CloudHSMV2
|
|
869
954
|
# When you receive a response with no `NextToken` (or an empty or null
|
870
955
|
# value), that means there are no more clusters to get.
|
871
956
|
#
|
957
|
+
# **Cross-account use:** No. You cannot perform this operation on
|
958
|
+
# CloudHSM clusters in a different Amazon Web Services account.
|
959
|
+
#
|
872
960
|
# @option params [Hash<String,Array>] :filters
|
873
961
|
# One or more filters to limit the items returned in the response.
|
874
962
|
#
|
@@ -954,12 +1042,47 @@ module Aws::CloudHSMV2
|
|
954
1042
|
req.send_request(options)
|
955
1043
|
end
|
956
1044
|
|
957
|
-
#
|
1045
|
+
# Retrieves the resource policy document attached to a given resource.
|
1046
|
+
#
|
1047
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1048
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
1049
|
+
#
|
1050
|
+
# @option params [String] :resource_arn
|
1051
|
+
# Amazon Resource Name (ARN) of the resource to which a policy is
|
1052
|
+
# attached.
|
1053
|
+
#
|
1054
|
+
# @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1055
|
+
#
|
1056
|
+
# * {Types::GetResourcePolicyResponse#policy #policy} => String
|
1057
|
+
#
|
1058
|
+
# @example Request syntax with placeholder values
|
1059
|
+
#
|
1060
|
+
# resp = client.get_resource_policy({
|
1061
|
+
# resource_arn: "CloudHsmArn",
|
1062
|
+
# })
|
1063
|
+
#
|
1064
|
+
# @example Response structure
|
1065
|
+
#
|
1066
|
+
# resp.policy #=> String
|
1067
|
+
#
|
1068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/GetResourcePolicy AWS API Documentation
|
1069
|
+
#
|
1070
|
+
# @overload get_resource_policy(params = {})
|
1071
|
+
# @param [Hash] params ({})
|
1072
|
+
def get_resource_policy(params = {}, options = {})
|
1073
|
+
req = build_request(:get_resource_policy, params)
|
1074
|
+
req.send_request(options)
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# Claims an CloudHSM cluster by submitting the cluster certificate
|
958
1078
|
# issued by your issuing certificate authority (CA) and the CA's root
|
959
1079
|
# certificate. Before you can claim a cluster, you must sign the
|
960
1080
|
# cluster's certificate signing request (CSR) with your issuing CA. To
|
961
1081
|
# get the cluster's CSR, use DescribeClusters.
|
962
1082
|
#
|
1083
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1084
|
+
# CloudHSM cluster in a different Amazon Web Services account.
|
1085
|
+
#
|
963
1086
|
# @option params [required, String] :cluster_id
|
964
1087
|
# The identifier (ID) of the cluster that you are claiming. To find the
|
965
1088
|
# cluster ID, use DescribeClusters.
|
@@ -1003,7 +1126,7 @@ module Aws::CloudHSMV2
|
|
1003
1126
|
req.send_request(options)
|
1004
1127
|
end
|
1005
1128
|
|
1006
|
-
# Gets a list of tags for the specified
|
1129
|
+
# Gets a list of tags for the specified CloudHSM cluster.
|
1007
1130
|
#
|
1008
1131
|
# This is a paginated operation, which means that each response might
|
1009
1132
|
# contain only a subset of all the tags. When the response contains only
|
@@ -1012,6 +1135,9 @@ module Aws::CloudHSMV2
|
|
1012
1135
|
# response with no `NextToken` (or an empty or null value), that means
|
1013
1136
|
# there are no more tags to get.
|
1014
1137
|
#
|
1138
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1139
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
1140
|
+
#
|
1015
1141
|
# @option params [required, String] :resource_id
|
1016
1142
|
# The cluster identifier (ID) for the cluster whose tags you are
|
1017
1143
|
# getting. To find the cluster ID, use DescribeClusters.
|
@@ -1056,7 +1182,10 @@ module Aws::CloudHSMV2
|
|
1056
1182
|
req.send_request(options)
|
1057
1183
|
end
|
1058
1184
|
|
1059
|
-
# Modifies attributes for
|
1185
|
+
# Modifies attributes for CloudHSM backup.
|
1186
|
+
#
|
1187
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1188
|
+
# CloudHSM backup in a different Amazon Web Services account.
|
1060
1189
|
#
|
1061
1190
|
# @option params [required, String] :backup_id
|
1062
1191
|
# The identifier (ID) of the backup to modify. To find the ID of a
|
@@ -1082,6 +1211,7 @@ module Aws::CloudHSMV2
|
|
1082
1211
|
# @example Response structure
|
1083
1212
|
#
|
1084
1213
|
# resp.backup.backup_id #=> String
|
1214
|
+
# resp.backup.backup_arn #=> String
|
1085
1215
|
# resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
|
1086
1216
|
# resp.backup.cluster_id #=> String
|
1087
1217
|
# resp.backup.create_timestamp #=> Time
|
@@ -1106,7 +1236,10 @@ module Aws::CloudHSMV2
|
|
1106
1236
|
req.send_request(options)
|
1107
1237
|
end
|
1108
1238
|
|
1109
|
-
# Modifies
|
1239
|
+
# Modifies CloudHSM cluster.
|
1240
|
+
#
|
1241
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1242
|
+
# CloudHSM cluster in a different Amazon Web Services account.
|
1110
1243
|
#
|
1111
1244
|
# @option params [required, Types::BackupRetentionPolicy] :backup_retention_policy
|
1112
1245
|
# A policy that defines how the service retains backups.
|
@@ -1173,9 +1306,83 @@ module Aws::CloudHSMV2
|
|
1173
1306
|
req.send_request(options)
|
1174
1307
|
end
|
1175
1308
|
|
1176
|
-
#
|
1177
|
-
#
|
1178
|
-
#
|
1309
|
+
# Creates or updates an CloudHSM resource policy. A resource policy
|
1310
|
+
# helps you to define the IAM entity (for example, an Amazon Web
|
1311
|
+
# Services account) that can manage your CloudHSM resources. The
|
1312
|
+
# following resources support CloudHSM resource policies:
|
1313
|
+
#
|
1314
|
+
# * Backup - The resource policy allows you to describe the backup and
|
1315
|
+
# restore a cluster from the backup in another Amazon Web Services
|
1316
|
+
# account.
|
1317
|
+
#
|
1318
|
+
# ^
|
1319
|
+
#
|
1320
|
+
# In order to share a backup, it must be in a 'READY' state and you
|
1321
|
+
# must own it.
|
1322
|
+
#
|
1323
|
+
# While you can share a backup using the CloudHSM PutResourcePolicy
|
1324
|
+
# operation, we recommend using Resource Access Manager (RAM) instead.
|
1325
|
+
# Using RAM provides multiple benefits as it creates the policy for you,
|
1326
|
+
# allows multiple resources to be shared at one time, and increases the
|
1327
|
+
# discoverability of shared resources. If you use PutResourcePolicy and
|
1328
|
+
# want consumers to be able to describe the backups you share with them,
|
1329
|
+
# you must promote the backup to a standard RAM Resource Share using the
|
1330
|
+
# RAM PromoteResourceShareCreatedFromPolicy API operation. For more
|
1331
|
+
# information, see [ Working with shared backups][1] in the CloudHSM
|
1332
|
+
# User Guide
|
1333
|
+
#
|
1334
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1335
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
1336
|
+
#
|
1337
|
+
#
|
1338
|
+
#
|
1339
|
+
# [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html
|
1340
|
+
#
|
1341
|
+
# @option params [String] :resource_arn
|
1342
|
+
# Amazon Resource Name (ARN) of the resource to which you want to attach
|
1343
|
+
# a policy.
|
1344
|
+
#
|
1345
|
+
# @option params [String] :policy
|
1346
|
+
# The policy you want to associate with a resource.
|
1347
|
+
#
|
1348
|
+
# For an example policy, see [ Working with shared backups][1] in the
|
1349
|
+
# CloudHSM User Guide
|
1350
|
+
#
|
1351
|
+
#
|
1352
|
+
#
|
1353
|
+
# [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html
|
1354
|
+
#
|
1355
|
+
# @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
|
+
#
|
1357
|
+
# * {Types::PutResourcePolicyResponse#resource_arn #resource_arn} => String
|
1358
|
+
# * {Types::PutResourcePolicyResponse#policy #policy} => String
|
1359
|
+
#
|
1360
|
+
# @example Request syntax with placeholder values
|
1361
|
+
#
|
1362
|
+
# resp = client.put_resource_policy({
|
1363
|
+
# resource_arn: "CloudHsmArn",
|
1364
|
+
# policy: "ResourcePolicy",
|
1365
|
+
# })
|
1366
|
+
#
|
1367
|
+
# @example Response structure
|
1368
|
+
#
|
1369
|
+
# resp.resource_arn #=> String
|
1370
|
+
# resp.policy #=> String
|
1371
|
+
#
|
1372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/PutResourcePolicy AWS API Documentation
|
1373
|
+
#
|
1374
|
+
# @overload put_resource_policy(params = {})
|
1375
|
+
# @param [Hash] params ({})
|
1376
|
+
def put_resource_policy(params = {}, options = {})
|
1377
|
+
req = build_request(:put_resource_policy, params)
|
1378
|
+
req.send_request(options)
|
1379
|
+
end
|
1380
|
+
|
1381
|
+
# Restores a specified CloudHSM backup that is in the `PENDING_DELETION`
|
1382
|
+
# state. For more information on deleting a backup, see DeleteBackup.
|
1383
|
+
#
|
1384
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1385
|
+
# CloudHSM backup in a different Amazon Web Services account.
|
1179
1386
|
#
|
1180
1387
|
# @option params [required, String] :backup_id
|
1181
1388
|
# The ID of the backup to be restored. To find the ID of a backup, use
|
@@ -1194,6 +1401,7 @@ module Aws::CloudHSMV2
|
|
1194
1401
|
# @example Response structure
|
1195
1402
|
#
|
1196
1403
|
# resp.backup.backup_id #=> String
|
1404
|
+
# resp.backup.backup_arn #=> String
|
1197
1405
|
# resp.backup.backup_state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETED", "PENDING_DELETION"
|
1198
1406
|
# resp.backup.cluster_id #=> String
|
1199
1407
|
# resp.backup.create_timestamp #=> Time
|
@@ -1218,9 +1426,12 @@ module Aws::CloudHSMV2
|
|
1218
1426
|
req.send_request(options)
|
1219
1427
|
end
|
1220
1428
|
|
1221
|
-
# Adds or overwrites one or more tags for the specified
|
1429
|
+
# Adds or overwrites one or more tags for the specified CloudHSM
|
1222
1430
|
# cluster.
|
1223
1431
|
#
|
1432
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1433
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
1434
|
+
#
|
1224
1435
|
# @option params [required, String] :resource_id
|
1225
1436
|
# The cluster identifier (ID) for the cluster that you are tagging. To
|
1226
1437
|
# find the cluster ID, use DescribeClusters.
|
@@ -1251,8 +1462,10 @@ module Aws::CloudHSMV2
|
|
1251
1462
|
req.send_request(options)
|
1252
1463
|
end
|
1253
1464
|
|
1254
|
-
# Removes the specified tag or tags from the specified
|
1255
|
-
#
|
1465
|
+
# Removes the specified tag or tags from the specified CloudHSM cluster.
|
1466
|
+
#
|
1467
|
+
# **Cross-account use:** No. You cannot perform this operation on an
|
1468
|
+
# CloudHSM resource in a different Amazon Web Services account.
|
1256
1469
|
#
|
1257
1470
|
# @option params [required, String] :resource_id
|
1258
1471
|
# The cluster identifier (ID) for the cluster whose tags you are
|
@@ -1293,7 +1506,7 @@ module Aws::CloudHSMV2
|
|
1293
1506
|
params: params,
|
1294
1507
|
config: config)
|
1295
1508
|
context[:gem_name] = 'aws-sdk-cloudhsmv2'
|
1296
|
-
context[:gem_version] = '1.
|
1509
|
+
context[:gem_version] = '1.61.0'
|
1297
1510
|
Seahorse::Client::Request.new(handlers, context)
|
1298
1511
|
end
|
1299
1512
|
|
@@ -14,6 +14,7 @@ module Aws::CloudHSMV2
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
16
|
Backup = Shapes::StructureShape.new(name: 'Backup')
|
17
|
+
BackupArn = Shapes::StringShape.new(name: 'BackupArn')
|
17
18
|
BackupId = Shapes::StringShape.new(name: 'BackupId')
|
18
19
|
BackupPolicy = Shapes::StringShape.new(name: 'BackupPolicy')
|
19
20
|
BackupRetentionPolicy = Shapes::StructureShape.new(name: 'BackupRetentionPolicy')
|
@@ -26,6 +27,7 @@ module Aws::CloudHSMV2
|
|
26
27
|
Cert = Shapes::StringShape.new(name: 'Cert')
|
27
28
|
Certificates = Shapes::StructureShape.new(name: 'Certificates')
|
28
29
|
CloudHsmAccessDeniedException = Shapes::StructureShape.new(name: 'CloudHsmAccessDeniedException')
|
30
|
+
CloudHsmArn = Shapes::StringShape.new(name: 'CloudHsmArn')
|
29
31
|
CloudHsmInternalFailureException = Shapes::StructureShape.new(name: 'CloudHsmInternalFailureException')
|
30
32
|
CloudHsmInvalidRequestException = Shapes::StructureShape.new(name: 'CloudHsmInvalidRequestException')
|
31
33
|
CloudHsmResourceNotFoundException = Shapes::StructureShape.new(name: 'CloudHsmResourceNotFoundException')
|
@@ -49,6 +51,8 @@ module Aws::CloudHSMV2
|
|
49
51
|
DeleteClusterResponse = Shapes::StructureShape.new(name: 'DeleteClusterResponse')
|
50
52
|
DeleteHsmRequest = Shapes::StructureShape.new(name: 'DeleteHsmRequest')
|
51
53
|
DeleteHsmResponse = Shapes::StructureShape.new(name: 'DeleteHsmResponse')
|
54
|
+
DeleteResourcePolicyRequest = Shapes::StructureShape.new(name: 'DeleteResourcePolicyRequest')
|
55
|
+
DeleteResourcePolicyResponse = Shapes::StructureShape.new(name: 'DeleteResourcePolicyResponse')
|
52
56
|
DescribeBackupsRequest = Shapes::StructureShape.new(name: 'DescribeBackupsRequest')
|
53
57
|
DescribeBackupsResponse = Shapes::StructureShape.new(name: 'DescribeBackupsResponse')
|
54
58
|
DescribeClustersRequest = Shapes::StructureShape.new(name: 'DescribeClustersRequest')
|
@@ -59,6 +63,8 @@ module Aws::CloudHSMV2
|
|
59
63
|
ExternalSubnetMapping = Shapes::MapShape.new(name: 'ExternalSubnetMapping')
|
60
64
|
Field = Shapes::StringShape.new(name: 'Field')
|
61
65
|
Filters = Shapes::MapShape.new(name: 'Filters')
|
66
|
+
GetResourcePolicyRequest = Shapes::StructureShape.new(name: 'GetResourcePolicyRequest')
|
67
|
+
GetResourcePolicyResponse = Shapes::StructureShape.new(name: 'GetResourcePolicyResponse')
|
62
68
|
Hsm = Shapes::StructureShape.new(name: 'Hsm')
|
63
69
|
HsmId = Shapes::StringShape.new(name: 'HsmId')
|
64
70
|
HsmState = Shapes::StringShape.new(name: 'HsmState')
|
@@ -76,8 +82,11 @@ module Aws::CloudHSMV2
|
|
76
82
|
ModifyClusterResponse = Shapes::StructureShape.new(name: 'ModifyClusterResponse')
|
77
83
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
78
84
|
PreCoPassword = Shapes::StringShape.new(name: 'PreCoPassword')
|
85
|
+
PutResourcePolicyRequest = Shapes::StructureShape.new(name: 'PutResourcePolicyRequest')
|
86
|
+
PutResourcePolicyResponse = Shapes::StructureShape.new(name: 'PutResourcePolicyResponse')
|
79
87
|
Region = Shapes::StringShape.new(name: 'Region')
|
80
88
|
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
89
|
+
ResourcePolicy = Shapes::StringShape.new(name: 'ResourcePolicy')
|
81
90
|
RestoreBackupRequest = Shapes::StructureShape.new(name: 'RestoreBackupRequest')
|
82
91
|
RestoreBackupResponse = Shapes::StructureShape.new(name: 'RestoreBackupResponse')
|
83
92
|
SecurityGroup = Shapes::StringShape.new(name: 'SecurityGroup')
|
@@ -100,6 +109,7 @@ module Aws::CloudHSMV2
|
|
100
109
|
errorMessage = Shapes::StringShape.new(name: 'errorMessage')
|
101
110
|
|
102
111
|
Backup.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
|
112
|
+
Backup.add_member(:backup_arn, Shapes::ShapeRef.new(shape: BackupArn, location_name: "BackupArn"))
|
103
113
|
Backup.add_member(:backup_state, Shapes::ShapeRef.new(shape: BackupState, location_name: "BackupState"))
|
104
114
|
Backup.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, location_name: "ClusterId"))
|
105
115
|
Backup.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateTimestamp"))
|
@@ -175,7 +185,7 @@ module Aws::CloudHSMV2
|
|
175
185
|
|
176
186
|
CreateClusterRequest.add_member(:backup_retention_policy, Shapes::ShapeRef.new(shape: BackupRetentionPolicy, location_name: "BackupRetentionPolicy"))
|
177
187
|
CreateClusterRequest.add_member(:hsm_type, Shapes::ShapeRef.new(shape: HsmType, required: true, location_name: "HsmType"))
|
178
|
-
CreateClusterRequest.add_member(:source_backup_id, Shapes::ShapeRef.new(shape:
|
188
|
+
CreateClusterRequest.add_member(:source_backup_id, Shapes::ShapeRef.new(shape: BackupArn, location_name: "SourceBackupId"))
|
179
189
|
CreateClusterRequest.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "SubnetIds"))
|
180
190
|
CreateClusterRequest.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
|
181
191
|
CreateClusterRequest.add_member(:mode, Shapes::ShapeRef.new(shape: ClusterMode, location_name: "Mode"))
|
@@ -213,9 +223,17 @@ module Aws::CloudHSMV2
|
|
213
223
|
DeleteHsmResponse.add_member(:hsm_id, Shapes::ShapeRef.new(shape: HsmId, location_name: "HsmId"))
|
214
224
|
DeleteHsmResponse.struct_class = Types::DeleteHsmResponse
|
215
225
|
|
226
|
+
DeleteResourcePolicyRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: CloudHsmArn, location_name: "ResourceArn"))
|
227
|
+
DeleteResourcePolicyRequest.struct_class = Types::DeleteResourcePolicyRequest
|
228
|
+
|
229
|
+
DeleteResourcePolicyResponse.add_member(:resource_arn, Shapes::ShapeRef.new(shape: CloudHsmArn, location_name: "ResourceArn"))
|
230
|
+
DeleteResourcePolicyResponse.add_member(:policy, Shapes::ShapeRef.new(shape: ResourcePolicy, location_name: "Policy"))
|
231
|
+
DeleteResourcePolicyResponse.struct_class = Types::DeleteResourcePolicyResponse
|
232
|
+
|
216
233
|
DescribeBackupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
217
234
|
DescribeBackupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: BackupsMaxSize, location_name: "MaxResults"))
|
218
235
|
DescribeBackupsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
236
|
+
DescribeBackupsRequest.add_member(:shared, Shapes::ShapeRef.new(shape: Boolean, location_name: "Shared"))
|
219
237
|
DescribeBackupsRequest.add_member(:sort_ascending, Shapes::ShapeRef.new(shape: Boolean, location_name: "SortAscending"))
|
220
238
|
DescribeBackupsRequest.struct_class = Types::DescribeBackupsRequest
|
221
239
|
|
@@ -244,6 +262,12 @@ module Aws::CloudHSMV2
|
|
244
262
|
Filters.key = Shapes::ShapeRef.new(shape: Field)
|
245
263
|
Filters.value = Shapes::ShapeRef.new(shape: Strings)
|
246
264
|
|
265
|
+
GetResourcePolicyRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: CloudHsmArn, location_name: "ResourceArn"))
|
266
|
+
GetResourcePolicyRequest.struct_class = Types::GetResourcePolicyRequest
|
267
|
+
|
268
|
+
GetResourcePolicyResponse.add_member(:policy, Shapes::ShapeRef.new(shape: ResourcePolicy, location_name: "Policy"))
|
269
|
+
GetResourcePolicyResponse.struct_class = Types::GetResourcePolicyResponse
|
270
|
+
|
247
271
|
Hsm.add_member(:availability_zone, Shapes::ShapeRef.new(shape: ExternalAz, location_name: "AvailabilityZone"))
|
248
272
|
Hsm.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, location_name: "ClusterId"))
|
249
273
|
Hsm.add_member(:subnet_id, Shapes::ShapeRef.new(shape: SubnetId, location_name: "SubnetId"))
|
@@ -288,6 +312,14 @@ module Aws::CloudHSMV2
|
|
288
312
|
ModifyClusterResponse.add_member(:cluster, Shapes::ShapeRef.new(shape: Cluster, location_name: "Cluster"))
|
289
313
|
ModifyClusterResponse.struct_class = Types::ModifyClusterResponse
|
290
314
|
|
315
|
+
PutResourcePolicyRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: CloudHsmArn, location_name: "ResourceArn"))
|
316
|
+
PutResourcePolicyRequest.add_member(:policy, Shapes::ShapeRef.new(shape: ResourcePolicy, location_name: "Policy"))
|
317
|
+
PutResourcePolicyRequest.struct_class = Types::PutResourcePolicyRequest
|
318
|
+
|
319
|
+
PutResourcePolicyResponse.add_member(:resource_arn, Shapes::ShapeRef.new(shape: CloudHsmArn, location_name: "ResourceArn"))
|
320
|
+
PutResourcePolicyResponse.add_member(:policy, Shapes::ShapeRef.new(shape: ResourcePolicy, location_name: "Policy"))
|
321
|
+
PutResourcePolicyResponse.struct_class = Types::PutResourcePolicyResponse
|
322
|
+
|
291
323
|
RestoreBackupRequest.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
|
292
324
|
RestoreBackupRequest.struct_class = Types::RestoreBackupRequest
|
293
325
|
|
@@ -326,6 +358,7 @@ module Aws::CloudHSMV2
|
|
326
358
|
|
327
359
|
api.metadata = {
|
328
360
|
"apiVersion" => "2017-04-28",
|
361
|
+
"auth" => ["aws.auth#sigv4"],
|
329
362
|
"endpointPrefix" => "cloudhsmv2",
|
330
363
|
"jsonVersion" => "1.1",
|
331
364
|
"protocol" => "json",
|
@@ -420,6 +453,19 @@ module Aws::CloudHSMV2
|
|
420
453
|
o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
|
421
454
|
end)
|
422
455
|
|
456
|
+
api.add_operation(:delete_resource_policy, Seahorse::Model::Operation.new.tap do |o|
|
457
|
+
o.name = "DeleteResourcePolicy"
|
458
|
+
o.http_method = "POST"
|
459
|
+
o.http_request_uri = "/"
|
460
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteResourcePolicyRequest)
|
461
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteResourcePolicyResponse)
|
462
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
|
463
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
|
464
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
|
465
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
|
466
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
|
467
|
+
end)
|
468
|
+
|
423
469
|
api.add_operation(:describe_backups, Seahorse::Model::Operation.new.tap do |o|
|
424
470
|
o.name = "DescribeBackups"
|
425
471
|
o.http_method = "POST"
|
@@ -459,6 +505,19 @@ module Aws::CloudHSMV2
|
|
459
505
|
)
|
460
506
|
end)
|
461
507
|
|
508
|
+
api.add_operation(:get_resource_policy, Seahorse::Model::Operation.new.tap do |o|
|
509
|
+
o.name = "GetResourcePolicy"
|
510
|
+
o.http_method = "POST"
|
511
|
+
o.http_request_uri = "/"
|
512
|
+
o.input = Shapes::ShapeRef.new(shape: GetResourcePolicyRequest)
|
513
|
+
o.output = Shapes::ShapeRef.new(shape: GetResourcePolicyResponse)
|
514
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
|
515
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
|
516
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
|
517
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
|
518
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
|
519
|
+
end)
|
520
|
+
|
462
521
|
api.add_operation(:initialize_cluster, Seahorse::Model::Operation.new.tap do |o|
|
463
522
|
o.name = "InitializeCluster"
|
464
523
|
o.http_method = "POST"
|
@@ -518,6 +577,19 @@ module Aws::CloudHSMV2
|
|
518
577
|
o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
|
519
578
|
end)
|
520
579
|
|
580
|
+
api.add_operation(:put_resource_policy, Seahorse::Model::Operation.new.tap do |o|
|
581
|
+
o.name = "PutResourcePolicy"
|
582
|
+
o.http_method = "POST"
|
583
|
+
o.http_request_uri = "/"
|
584
|
+
o.input = Shapes::ShapeRef.new(shape: PutResourcePolicyRequest)
|
585
|
+
o.output = Shapes::ShapeRef.new(shape: PutResourcePolicyResponse)
|
586
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
|
587
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
|
588
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
|
589
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
|
590
|
+
o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
|
591
|
+
end)
|
592
|
+
|
521
593
|
api.add_operation(:restore_backup, Seahorse::Model::Operation.new.tap do |o|
|
522
594
|
o.name = "RestoreBackup"
|
523
595
|
o.http_method = "POST"
|
@@ -96,6 +96,20 @@ module Aws::CloudHSMV2
|
|
96
96
|
end
|
97
97
|
end
|
98
98
|
|
99
|
+
class DeleteResourcePolicy
|
100
|
+
def self.build(context)
|
101
|
+
unless context.config.regional_endpoint
|
102
|
+
endpoint = context.config.endpoint.to_s
|
103
|
+
end
|
104
|
+
Aws::CloudHSMV2::EndpointParameters.new(
|
105
|
+
region: context.config.region,
|
106
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
107
|
+
use_fips: context.config.use_fips_endpoint,
|
108
|
+
endpoint: endpoint,
|
109
|
+
)
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
99
113
|
class DescribeBackups
|
100
114
|
def self.build(context)
|
101
115
|
unless context.config.regional_endpoint
|
@@ -124,6 +138,20 @@ module Aws::CloudHSMV2
|
|
124
138
|
end
|
125
139
|
end
|
126
140
|
|
141
|
+
class GetResourcePolicy
|
142
|
+
def self.build(context)
|
143
|
+
unless context.config.regional_endpoint
|
144
|
+
endpoint = context.config.endpoint.to_s
|
145
|
+
end
|
146
|
+
Aws::CloudHSMV2::EndpointParameters.new(
|
147
|
+
region: context.config.region,
|
148
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
149
|
+
use_fips: context.config.use_fips_endpoint,
|
150
|
+
endpoint: endpoint,
|
151
|
+
)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
127
155
|
class InitializeCluster
|
128
156
|
def self.build(context)
|
129
157
|
unless context.config.regional_endpoint
|
@@ -180,6 +208,20 @@ module Aws::CloudHSMV2
|
|
180
208
|
end
|
181
209
|
end
|
182
210
|
|
211
|
+
class PutResourcePolicy
|
212
|
+
def self.build(context)
|
213
|
+
unless context.config.regional_endpoint
|
214
|
+
endpoint = context.config.endpoint.to_s
|
215
|
+
end
|
216
|
+
Aws::CloudHSMV2::EndpointParameters.new(
|
217
|
+
region: context.config.region,
|
218
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
219
|
+
use_fips: context.config.use_fips_endpoint,
|
220
|
+
endpoint: endpoint,
|
221
|
+
)
|
222
|
+
end
|
223
|
+
end
|
224
|
+
|
183
225
|
class RestoreBackup
|
184
226
|
def self.build(context)
|
185
227
|
unless context.config.regional_endpoint
|
@@ -70,10 +70,14 @@ module Aws::CloudHSMV2
|
|
70
70
|
Aws::CloudHSMV2::Endpoints::DeleteCluster.build(context)
|
71
71
|
when :delete_hsm
|
72
72
|
Aws::CloudHSMV2::Endpoints::DeleteHsm.build(context)
|
73
|
+
when :delete_resource_policy
|
74
|
+
Aws::CloudHSMV2::Endpoints::DeleteResourcePolicy.build(context)
|
73
75
|
when :describe_backups
|
74
76
|
Aws::CloudHSMV2::Endpoints::DescribeBackups.build(context)
|
75
77
|
when :describe_clusters
|
76
78
|
Aws::CloudHSMV2::Endpoints::DescribeClusters.build(context)
|
79
|
+
when :get_resource_policy
|
80
|
+
Aws::CloudHSMV2::Endpoints::GetResourcePolicy.build(context)
|
77
81
|
when :initialize_cluster
|
78
82
|
Aws::CloudHSMV2::Endpoints::InitializeCluster.build(context)
|
79
83
|
when :list_tags
|
@@ -82,6 +86,8 @@ module Aws::CloudHSMV2
|
|
82
86
|
Aws::CloudHSMV2::Endpoints::ModifyBackupAttributes.build(context)
|
83
87
|
when :modify_cluster
|
84
88
|
Aws::CloudHSMV2::Endpoints::ModifyCluster.build(context)
|
89
|
+
when :put_resource_policy
|
90
|
+
Aws::CloudHSMV2::Endpoints::PutResourcePolicy.build(context)
|
85
91
|
when :restore_backup
|
86
92
|
Aws::CloudHSMV2::Endpoints::RestoreBackup.build(context)
|
87
93
|
when :tag_resource
|
@@ -10,8 +10,8 @@
|
|
10
10
|
module Aws::CloudHSMV2
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Contains information about a backup of an
|
14
|
-
#
|
13
|
+
# Contains information about a backup of an CloudHSM cluster. All backup
|
14
|
+
# objects contain the `BackupId`, `BackupState`, `ClusterId`, and
|
15
15
|
# `CreateTimestamp` parameters. Backups that were copied into a
|
16
16
|
# destination region additionally contain the `CopyTimestamp`,
|
17
17
|
# `SourceBackup`, `SourceCluster`, and `SourceRegion` parameters. A
|
@@ -22,6 +22,10 @@ module Aws::CloudHSMV2
|
|
22
22
|
# The identifier (ID) of the backup.
|
23
23
|
# @return [String]
|
24
24
|
#
|
25
|
+
# @!attribute [rw] backup_arn
|
26
|
+
# The Amazon Resource Name (ARN) of the backup.
|
27
|
+
# @return [String]
|
28
|
+
#
|
25
29
|
# @!attribute [rw] backup_state
|
26
30
|
# The state of the backup.
|
27
31
|
# @return [String]
|
@@ -69,7 +73,7 @@ module Aws::CloudHSMV2
|
|
69
73
|
# @return [Array<Types::Tag>]
|
70
74
|
#
|
71
75
|
# @!attribute [rw] hsm_type
|
72
|
-
# The HSM type
|
76
|
+
# The HSM type used to create the backup.
|
73
77
|
# @return [String]
|
74
78
|
#
|
75
79
|
# @!attribute [rw] mode
|
@@ -80,6 +84,7 @@ module Aws::CloudHSMV2
|
|
80
84
|
#
|
81
85
|
class Backup < Struct.new(
|
82
86
|
:backup_id,
|
87
|
+
:backup_arn,
|
83
88
|
:backup_state,
|
84
89
|
:cluster_id,
|
85
90
|
:create_timestamp,
|
@@ -129,7 +134,7 @@ module Aws::CloudHSMV2
|
|
129
134
|
# @return [String]
|
130
135
|
#
|
131
136
|
# @!attribute [rw] aws_hardware_certificate
|
132
|
-
# The HSM hardware certificate issued (signed) by
|
137
|
+
# The HSM hardware certificate issued (signed) by CloudHSM.
|
133
138
|
# @return [String]
|
134
139
|
#
|
135
140
|
# @!attribute [rw] manufacturer_hardware_certificate
|
@@ -168,8 +173,8 @@ module Aws::CloudHSMV2
|
|
168
173
|
include Aws::Structure
|
169
174
|
end
|
170
175
|
|
171
|
-
# The request was rejected because of an
|
172
|
-
#
|
176
|
+
# The request was rejected because of an CloudHSM internal failure. The
|
177
|
+
# request can be retried.
|
173
178
|
#
|
174
179
|
# @!attribute [rw] message
|
175
180
|
# @return [String]
|
@@ -236,7 +241,7 @@ module Aws::CloudHSMV2
|
|
236
241
|
include Aws::Structure
|
237
242
|
end
|
238
243
|
|
239
|
-
# Contains information about an
|
244
|
+
# Contains information about an CloudHSM cluster.
|
240
245
|
#
|
241
246
|
# @!attribute [rw] backup_policy
|
242
247
|
# The cluster's backup policy.
|
@@ -385,9 +390,11 @@ module Aws::CloudHSMV2
|
|
385
390
|
# @return [String]
|
386
391
|
#
|
387
392
|
# @!attribute [rw] source_backup_id
|
388
|
-
# The identifier (ID)
|
389
|
-
# to restore
|
390
|
-
# cluster. To find the backup ID
|
393
|
+
# The identifier (ID) or the Amazon Resource Name (ARN) of the cluster
|
394
|
+
# backup to restore. Use this value to restore the cluster from a
|
395
|
+
# backup instead of creating a new cluster. To find the backup ID or
|
396
|
+
# ARN, use DescribeBackups. *If using a backup in another account, the
|
397
|
+
# full ARN must be supplied.*
|
391
398
|
# @return [String]
|
392
399
|
#
|
393
400
|
# @!attribute [rw] subnet_ids
|
@@ -565,6 +572,37 @@ module Aws::CloudHSMV2
|
|
565
572
|
include Aws::Structure
|
566
573
|
end
|
567
574
|
|
575
|
+
# @!attribute [rw] resource_arn
|
576
|
+
# Amazon Resource Name (ARN) of the resource from which the policy
|
577
|
+
# will be removed.
|
578
|
+
# @return [String]
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteResourcePolicyRequest AWS API Documentation
|
581
|
+
#
|
582
|
+
class DeleteResourcePolicyRequest < Struct.new(
|
583
|
+
:resource_arn)
|
584
|
+
SENSITIVE = []
|
585
|
+
include Aws::Structure
|
586
|
+
end
|
587
|
+
|
588
|
+
# @!attribute [rw] resource_arn
|
589
|
+
# Amazon Resource Name (ARN) of the resource from which the policy was
|
590
|
+
# deleted.
|
591
|
+
# @return [String]
|
592
|
+
#
|
593
|
+
# @!attribute [rw] policy
|
594
|
+
# The policy previously attached to the resource.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteResourcePolicyResponse AWS API Documentation
|
598
|
+
#
|
599
|
+
class DeleteResourcePolicyResponse < Struct.new(
|
600
|
+
:resource_arn,
|
601
|
+
:policy)
|
602
|
+
SENSITIVE = []
|
603
|
+
include Aws::Structure
|
604
|
+
end
|
605
|
+
|
568
606
|
# @!attribute [rw] next_token
|
569
607
|
# The `NextToken` value that you received in the previous response.
|
570
608
|
# Use this value to get more backups.
|
@@ -599,6 +637,26 @@ module Aws::CloudHSMV2
|
|
599
637
|
# with a backup retention policy defined at the cluster.
|
600
638
|
# @return [Hash<String,Array<String>>]
|
601
639
|
#
|
640
|
+
# @!attribute [rw] shared
|
641
|
+
# Describe backups that are shared with you.
|
642
|
+
#
|
643
|
+
# <note markdown="1"> By default when using this option, the command returns backups that
|
644
|
+
# have been shared using a standard Resource Access Manager resource
|
645
|
+
# share. In order for a backup that was shared using the
|
646
|
+
# PutResourcePolicy command to be returned, the share must be promoted
|
647
|
+
# to a standard resource share using the RAM
|
648
|
+
# [PromoteResourceShareCreatedFromPolicy][1] API operation. For more
|
649
|
+
# information about sharing backups, see [ Working with shared
|
650
|
+
# backups][2] in the CloudHSM User Guide.
|
651
|
+
#
|
652
|
+
# </note>
|
653
|
+
#
|
654
|
+
#
|
655
|
+
#
|
656
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html
|
657
|
+
# [2]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html
|
658
|
+
# @return [Boolean]
|
659
|
+
#
|
602
660
|
# @!attribute [rw] sort_ascending
|
603
661
|
# Designates whether or not to sort the return backups by ascending
|
604
662
|
# chronological order of generation.
|
@@ -610,6 +668,7 @@ module Aws::CloudHSMV2
|
|
610
668
|
:next_token,
|
611
669
|
:max_results,
|
612
670
|
:filters,
|
671
|
+
:shared,
|
613
672
|
:sort_ascending)
|
614
673
|
SENSITIVE = []
|
615
674
|
include Aws::Structure
|
@@ -721,7 +780,32 @@ module Aws::CloudHSMV2
|
|
721
780
|
include Aws::Structure
|
722
781
|
end
|
723
782
|
|
724
|
-
#
|
783
|
+
# @!attribute [rw] resource_arn
|
784
|
+
# Amazon Resource Name (ARN) of the resource to which a policy is
|
785
|
+
# attached.
|
786
|
+
# @return [String]
|
787
|
+
#
|
788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/GetResourcePolicyRequest AWS API Documentation
|
789
|
+
#
|
790
|
+
class GetResourcePolicyRequest < Struct.new(
|
791
|
+
:resource_arn)
|
792
|
+
SENSITIVE = []
|
793
|
+
include Aws::Structure
|
794
|
+
end
|
795
|
+
|
796
|
+
# @!attribute [rw] policy
|
797
|
+
# The policy attached to a resource.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/GetResourcePolicyResponse AWS API Documentation
|
801
|
+
#
|
802
|
+
class GetResourcePolicyResponse < Struct.new(
|
803
|
+
:policy)
|
804
|
+
SENSITIVE = []
|
805
|
+
include Aws::Structure
|
806
|
+
end
|
807
|
+
|
808
|
+
# Contains information about a hardware security module (HSM) in an
|
725
809
|
# CloudHSM cluster.
|
726
810
|
#
|
727
811
|
# @!attribute [rw] availability_zone
|
@@ -885,7 +969,7 @@ module Aws::CloudHSMV2
|
|
885
969
|
end
|
886
970
|
|
887
971
|
# @!attribute [rw] backup
|
888
|
-
# Contains information about a backup of an
|
972
|
+
# Contains information about a backup of an CloudHSM cluster. All
|
889
973
|
# backup objects contain the `BackupId`, `BackupState`, `ClusterId`,
|
890
974
|
# and `CreateTimestamp` parameters. Backups that were copied into a
|
891
975
|
# destination region additionally contain the `CopyTimestamp`,
|
@@ -921,7 +1005,7 @@ module Aws::CloudHSMV2
|
|
921
1005
|
end
|
922
1006
|
|
923
1007
|
# @!attribute [rw] cluster
|
924
|
-
# Contains information about an
|
1008
|
+
# Contains information about an CloudHSM cluster.
|
925
1009
|
# @return [Types::Cluster]
|
926
1010
|
#
|
927
1011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyClusterResponse AWS API Documentation
|
@@ -932,6 +1016,49 @@ module Aws::CloudHSMV2
|
|
932
1016
|
include Aws::Structure
|
933
1017
|
end
|
934
1018
|
|
1019
|
+
# @!attribute [rw] resource_arn
|
1020
|
+
# Amazon Resource Name (ARN) of the resource to which you want to
|
1021
|
+
# attach a policy.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] policy
|
1025
|
+
# The policy you want to associate with a resource.
|
1026
|
+
#
|
1027
|
+
# For an example policy, see [ Working with shared backups][1] in the
|
1028
|
+
# CloudHSM User Guide
|
1029
|
+
#
|
1030
|
+
#
|
1031
|
+
#
|
1032
|
+
# [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/PutResourcePolicyRequest AWS API Documentation
|
1036
|
+
#
|
1037
|
+
class PutResourcePolicyRequest < Struct.new(
|
1038
|
+
:resource_arn,
|
1039
|
+
:policy)
|
1040
|
+
SENSITIVE = []
|
1041
|
+
include Aws::Structure
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
# @!attribute [rw] resource_arn
|
1045
|
+
# Amazon Resource Name (ARN) of the resource to which a policy is
|
1046
|
+
# attached.
|
1047
|
+
# @return [String]
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] policy
|
1050
|
+
# The policy attached to a resource.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/PutResourcePolicyResponse AWS API Documentation
|
1054
|
+
#
|
1055
|
+
class PutResourcePolicyResponse < Struct.new(
|
1056
|
+
:resource_arn,
|
1057
|
+
:policy)
|
1058
|
+
SENSITIVE = []
|
1059
|
+
include Aws::Structure
|
1060
|
+
end
|
1061
|
+
|
935
1062
|
# @!attribute [rw] backup_id
|
936
1063
|
# The ID of the backup to be restored. To find the ID of a backup, use
|
937
1064
|
# the DescribeBackups operation.
|
data/lib/aws-sdk-cloudhsmv2.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -158,6 +158,17 @@ module Aws
|
|
158
158
|
) -> _DeleteHsmResponseSuccess
|
159
159
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteHsmResponseSuccess
|
160
160
|
|
161
|
+
interface _DeleteResourcePolicyResponseSuccess
|
162
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteResourcePolicyResponse]
|
163
|
+
def resource_arn: () -> ::String
|
164
|
+
def policy: () -> ::String
|
165
|
+
end
|
166
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudHSMV2/Client.html#delete_resource_policy-instance_method
|
167
|
+
def delete_resource_policy: (
|
168
|
+
?resource_arn: ::String
|
169
|
+
) -> _DeleteResourcePolicyResponseSuccess
|
170
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteResourcePolicyResponseSuccess
|
171
|
+
|
161
172
|
interface _DescribeBackupsResponseSuccess
|
162
173
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeBackupsResponse]
|
163
174
|
def backups: () -> ::Array[Types::Backup]
|
@@ -168,6 +179,7 @@ module Aws
|
|
168
179
|
?next_token: ::String,
|
169
180
|
?max_results: ::Integer,
|
170
181
|
?filters: Hash[::String, Array[::String]],
|
182
|
+
?shared: bool,
|
171
183
|
?sort_ascending: bool
|
172
184
|
) -> _DescribeBackupsResponseSuccess
|
173
185
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeBackupsResponseSuccess
|
@@ -185,6 +197,16 @@ module Aws
|
|
185
197
|
) -> _DescribeClustersResponseSuccess
|
186
198
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeClustersResponseSuccess
|
187
199
|
|
200
|
+
interface _GetResourcePolicyResponseSuccess
|
201
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetResourcePolicyResponse]
|
202
|
+
def policy: () -> ::String
|
203
|
+
end
|
204
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudHSMV2/Client.html#get_resource_policy-instance_method
|
205
|
+
def get_resource_policy: (
|
206
|
+
?resource_arn: ::String
|
207
|
+
) -> _GetResourcePolicyResponseSuccess
|
208
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcePolicyResponseSuccess
|
209
|
+
|
188
210
|
interface _InitializeClusterResponseSuccess
|
189
211
|
include ::Seahorse::Client::_ResponseSuccess[Types::InitializeClusterResponse]
|
190
212
|
def state: () -> ("CREATE_IN_PROGRESS" | "UNINITIALIZED" | "INITIALIZE_IN_PROGRESS" | "INITIALIZED" | "ACTIVE" | "UPDATE_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "DELETED" | "DEGRADED")
|
@@ -236,6 +258,18 @@ module Aws
|
|
236
258
|
) -> _ModifyClusterResponseSuccess
|
237
259
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ModifyClusterResponseSuccess
|
238
260
|
|
261
|
+
interface _PutResourcePolicyResponseSuccess
|
262
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutResourcePolicyResponse]
|
263
|
+
def resource_arn: () -> ::String
|
264
|
+
def policy: () -> ::String
|
265
|
+
end
|
266
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudHSMV2/Client.html#put_resource_policy-instance_method
|
267
|
+
def put_resource_policy: (
|
268
|
+
?resource_arn: ::String,
|
269
|
+
?policy: ::String
|
270
|
+
) -> _PutResourcePolicyResponseSuccess
|
271
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutResourcePolicyResponseSuccess
|
272
|
+
|
239
273
|
interface _RestoreBackupResponseSuccess
|
240
274
|
include ::Seahorse::Client::_ResponseSuccess[Types::RestoreBackupResponse]
|
241
275
|
def backup: () -> Types::Backup
|
data/sig/types.rbs
CHANGED
@@ -10,6 +10,7 @@ module Aws::CloudHSMV2
|
|
10
10
|
|
11
11
|
class Backup
|
12
12
|
attr_accessor backup_id: ::String
|
13
|
+
attr_accessor backup_arn: ::String
|
13
14
|
attr_accessor backup_state: ("CREATE_IN_PROGRESS" | "READY" | "DELETED" | "PENDING_DELETION")
|
14
15
|
attr_accessor cluster_id: ::String
|
15
16
|
attr_accessor create_timestamp: ::Time
|
@@ -162,10 +163,22 @@ module Aws::CloudHSMV2
|
|
162
163
|
SENSITIVE: []
|
163
164
|
end
|
164
165
|
|
166
|
+
class DeleteResourcePolicyRequest
|
167
|
+
attr_accessor resource_arn: ::String
|
168
|
+
SENSITIVE: []
|
169
|
+
end
|
170
|
+
|
171
|
+
class DeleteResourcePolicyResponse
|
172
|
+
attr_accessor resource_arn: ::String
|
173
|
+
attr_accessor policy: ::String
|
174
|
+
SENSITIVE: []
|
175
|
+
end
|
176
|
+
|
165
177
|
class DescribeBackupsRequest
|
166
178
|
attr_accessor next_token: ::String
|
167
179
|
attr_accessor max_results: ::Integer
|
168
180
|
attr_accessor filters: ::Hash[::String, ::Array[::String]]
|
181
|
+
attr_accessor shared: bool
|
169
182
|
attr_accessor sort_ascending: bool
|
170
183
|
SENSITIVE: []
|
171
184
|
end
|
@@ -197,6 +210,16 @@ module Aws::CloudHSMV2
|
|
197
210
|
SENSITIVE: []
|
198
211
|
end
|
199
212
|
|
213
|
+
class GetResourcePolicyRequest
|
214
|
+
attr_accessor resource_arn: ::String
|
215
|
+
SENSITIVE: []
|
216
|
+
end
|
217
|
+
|
218
|
+
class GetResourcePolicyResponse
|
219
|
+
attr_accessor policy: ::String
|
220
|
+
SENSITIVE: []
|
221
|
+
end
|
222
|
+
|
200
223
|
class Hsm
|
201
224
|
attr_accessor availability_zone: ::String
|
202
225
|
attr_accessor cluster_id: ::String
|
@@ -257,6 +280,18 @@ module Aws::CloudHSMV2
|
|
257
280
|
SENSITIVE: []
|
258
281
|
end
|
259
282
|
|
283
|
+
class PutResourcePolicyRequest
|
284
|
+
attr_accessor resource_arn: ::String
|
285
|
+
attr_accessor policy: ::String
|
286
|
+
SENSITIVE: []
|
287
|
+
end
|
288
|
+
|
289
|
+
class PutResourcePolicyResponse
|
290
|
+
attr_accessor resource_arn: ::String
|
291
|
+
attr_accessor policy: ::String
|
292
|
+
SENSITIVE: []
|
293
|
+
end
|
294
|
+
|
260
295
|
class RestoreBackupRequest
|
261
296
|
attr_accessor backup_id: ::String
|
262
297
|
SENSITIVE: []
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudhsmv2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.61.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-06-
|
11
|
+
date: 2024-06-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|