aws-sdk-secretsmanager 1.146.0 → 1.147.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +460 -22
- data/lib/aws-sdk-secretsmanager/client_api.rb +112 -0
- data/lib/aws-sdk-secretsmanager/types.rb +379 -12
- data/lib/aws-sdk-secretsmanager.rb +2 -2
- data/sig/client.rbs +52 -3
- data/sig/types.rbs +70 -1
- metadata +1 -1
|
@@ -39,6 +39,95 @@ module Aws::SecretsManager
|
|
|
39
39
|
include Aws::Structure
|
|
40
40
|
end
|
|
41
41
|
|
|
42
|
+
# @!attribute [rw] secret_id
|
|
43
|
+
# The ARN or name of the primary secret in your account to replicate.
|
|
44
|
+
#
|
|
45
|
+
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
46
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
47
|
+
#
|
|
48
|
+
#
|
|
49
|
+
#
|
|
50
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
51
|
+
# @return [String]
|
|
52
|
+
#
|
|
53
|
+
# @!attribute [rw] cross_account_replica_arn
|
|
54
|
+
# The ARN of the replica secret in the other Amazon Web Services
|
|
55
|
+
# account. The replica secret must be in the same Region and partition
|
|
56
|
+
# as the primary secret. Additionally, the replica account owner must
|
|
57
|
+
# have created the replica secret as a cross-account replica of the
|
|
58
|
+
# primary secret. For more information see CreateSecret.
|
|
59
|
+
# @return [String]
|
|
60
|
+
#
|
|
61
|
+
# @!attribute [rw] replica_restriction
|
|
62
|
+
# Whether the replica account must belong to the same Amazon Web
|
|
63
|
+
# Services organization as the primary account:
|
|
64
|
+
#
|
|
65
|
+
# * `SameOrg`, which requires the replica account to be in the same
|
|
66
|
+
# organization as the primary account. This is the default.
|
|
67
|
+
#
|
|
68
|
+
# * `NoRestriction`, which allows the replica account to be in any
|
|
69
|
+
# organization.
|
|
70
|
+
# @return [String]
|
|
71
|
+
#
|
|
72
|
+
# @!attribute [rw] replication_role_arn
|
|
73
|
+
# The ARN of an IAM role in the primary account that Secrets Manager
|
|
74
|
+
# assumes to perform replication. If you don't include this field,
|
|
75
|
+
# Secrets Manager replicates using the credentials of caller who
|
|
76
|
+
# updates the primary secret. For more information, see [
|
|
77
|
+
# Cross-account replication permissions][1].
|
|
78
|
+
#
|
|
79
|
+
#
|
|
80
|
+
#
|
|
81
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/cross-account-replicate-permissions.html
|
|
82
|
+
# @return [String]
|
|
83
|
+
#
|
|
84
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/AssociateCrossAccountReplicaRequest AWS API Documentation
|
|
85
|
+
#
|
|
86
|
+
class AssociateCrossAccountReplicaRequest < Struct.new(
|
|
87
|
+
:secret_id,
|
|
88
|
+
:cross_account_replica_arn,
|
|
89
|
+
:replica_restriction,
|
|
90
|
+
:replication_role_arn)
|
|
91
|
+
SENSITIVE = []
|
|
92
|
+
include Aws::Structure
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# @!attribute [rw] arn
|
|
96
|
+
# The ARN of the primary secret.
|
|
97
|
+
# @return [String]
|
|
98
|
+
#
|
|
99
|
+
# @!attribute [rw] cross_account_replica_arn
|
|
100
|
+
# The ARN of the replica secret in the other account.
|
|
101
|
+
# @return [String]
|
|
102
|
+
#
|
|
103
|
+
# @!attribute [rw] replication_status
|
|
104
|
+
# The status of replication to the replica secret. Possible values:
|
|
105
|
+
#
|
|
106
|
+
# * `InSync`, which indicates that replication to the replica
|
|
107
|
+
# completed successfully and the replica is up to date.
|
|
108
|
+
#
|
|
109
|
+
# * `Failed`, which indicates that replication to the replica did not
|
|
110
|
+
# succeed.
|
|
111
|
+
#
|
|
112
|
+
# * `InProgress`, which indicates that Secrets Manager is replicating
|
|
113
|
+
# to the replica.
|
|
114
|
+
#
|
|
115
|
+
# * `Pending`, which indicates that replication has not yet started.
|
|
116
|
+
#
|
|
117
|
+
# * `Detached`, which indicates that primary secret is no longer
|
|
118
|
+
# linked to the replica secret.
|
|
119
|
+
# @return [String]
|
|
120
|
+
#
|
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/AssociateCrossAccountReplicaResponse AWS API Documentation
|
|
122
|
+
#
|
|
123
|
+
class AssociateCrossAccountReplicaResponse < Struct.new(
|
|
124
|
+
:arn,
|
|
125
|
+
:cross_account_replica_arn,
|
|
126
|
+
:replication_status)
|
|
127
|
+
SENSITIVE = []
|
|
128
|
+
include Aws::Structure
|
|
129
|
+
end
|
|
130
|
+
|
|
42
131
|
# @!attribute [rw] secret_id_list
|
|
43
132
|
# The ARN or names of the secrets to retrieve. You must include
|
|
44
133
|
# `Filters` or `SecretIdList`, but not both.
|
|
@@ -323,6 +412,16 @@ module Aws::SecretsManager
|
|
|
323
412
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html
|
|
324
413
|
# @return [String]
|
|
325
414
|
#
|
|
415
|
+
# @!attribute [rw] cross_account_primary_arn
|
|
416
|
+
# The ARN of a primary secret in another Amazon Web Services account.
|
|
417
|
+
# Include this field to create a cross-account replica secret that
|
|
418
|
+
# receives replicated data from that primary secret. The primary
|
|
419
|
+
# secret must be in the same Amazon Web Services Region and partition
|
|
420
|
+
# as the replica, and you must specify a customer managed KMS key in
|
|
421
|
+
# `KmsKeyId`. You can't include `SecretString`, `SecretBinary`,
|
|
422
|
+
# `Description`, `AddReplicaRegions`, or `Type`.
|
|
423
|
+
# @return [String]
|
|
424
|
+
#
|
|
326
425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecretRequest AWS API Documentation
|
|
327
426
|
#
|
|
328
427
|
class CreateSecretRequest < Struct.new(
|
|
@@ -335,7 +434,8 @@ module Aws::SecretsManager
|
|
|
335
434
|
:tags,
|
|
336
435
|
:add_replica_regions,
|
|
337
436
|
:force_overwrite_replica_secret,
|
|
338
|
-
:type
|
|
437
|
+
:type,
|
|
438
|
+
:cross_account_primary_arn)
|
|
339
439
|
SENSITIVE = [:secret_binary, :secret_string]
|
|
340
440
|
include Aws::Structure
|
|
341
441
|
end
|
|
@@ -378,6 +478,92 @@ module Aws::SecretsManager
|
|
|
378
478
|
include Aws::Structure
|
|
379
479
|
end
|
|
380
480
|
|
|
481
|
+
# Contains information about the primary secret that a cross-account
|
|
482
|
+
# replica secret replicates from, including its ARN and replication
|
|
483
|
+
# status. This information is only available for cross-account replica
|
|
484
|
+
# secrets.
|
|
485
|
+
#
|
|
486
|
+
# @!attribute [rw] primary_secret_arn
|
|
487
|
+
# The ARN of the primary secret replicating into this replica secret.
|
|
488
|
+
# @return [String]
|
|
489
|
+
#
|
|
490
|
+
# @!attribute [rw] replication_status
|
|
491
|
+
# The status of replication from the primary secret to this replica.
|
|
492
|
+
# The status can be:
|
|
493
|
+
#
|
|
494
|
+
# * `InSync`: Replication to the replica secret is complete.
|
|
495
|
+
#
|
|
496
|
+
# * `Failed`: Replication to the replica secret was unable to be
|
|
497
|
+
# completed.
|
|
498
|
+
#
|
|
499
|
+
# * `InProgress`: Replication to the replica secret has started but is
|
|
500
|
+
# not complete.
|
|
501
|
+
#
|
|
502
|
+
# * `Pending`: Replication has not yet started for the replica secret.
|
|
503
|
+
#
|
|
504
|
+
# * `Detached`: Replication to the replica secret was stopped by the
|
|
505
|
+
# primary.
|
|
506
|
+
# @return [String]
|
|
507
|
+
#
|
|
508
|
+
# @!attribute [rw] status_message
|
|
509
|
+
# A message that describes the replication status, if Secrets Manager
|
|
510
|
+
# has more information to provide.
|
|
511
|
+
# @return [String]
|
|
512
|
+
#
|
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CrossAccountPrimaryType AWS API Documentation
|
|
514
|
+
#
|
|
515
|
+
class CrossAccountPrimaryType < Struct.new(
|
|
516
|
+
:primary_secret_arn,
|
|
517
|
+
:replication_status,
|
|
518
|
+
:status_message)
|
|
519
|
+
SENSITIVE = []
|
|
520
|
+
include Aws::Structure
|
|
521
|
+
end
|
|
522
|
+
|
|
523
|
+
# Information about a cross-account replica secret. This information is
|
|
524
|
+
# only available for cross-account primary secrets.
|
|
525
|
+
#
|
|
526
|
+
# @!attribute [rw] replica_secret_arn
|
|
527
|
+
# The ARN of the replica secret.
|
|
528
|
+
# @return [String]
|
|
529
|
+
#
|
|
530
|
+
# @!attribute [rw] replication_role_arn
|
|
531
|
+
# The ARN of the IAM role that Secrets Manager assumes to replicate to
|
|
532
|
+
# this replica, if one was specified when the replica was associated.
|
|
533
|
+
# @return [String]
|
|
534
|
+
#
|
|
535
|
+
# @!attribute [rw] replication_status
|
|
536
|
+
# The status of replication from this primary secret. The status can
|
|
537
|
+
# be:
|
|
538
|
+
#
|
|
539
|
+
# * `InSync`: Replication from the primary secret is complete.
|
|
540
|
+
#
|
|
541
|
+
# * `Failed`: Replication from the primary secret was unable to be
|
|
542
|
+
# completed.
|
|
543
|
+
#
|
|
544
|
+
# * `InProgress`: Replication from the primary secret has started but
|
|
545
|
+
# is not complete.
|
|
546
|
+
#
|
|
547
|
+
# * `Detached`: Replication from the primary secret was stopped by the
|
|
548
|
+
# replica.
|
|
549
|
+
# @return [String]
|
|
550
|
+
#
|
|
551
|
+
# @!attribute [rw] status_message
|
|
552
|
+
# A message that describes the replication status, if Secrets Manager
|
|
553
|
+
# has more information to provide.
|
|
554
|
+
# @return [String]
|
|
555
|
+
#
|
|
556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CrossAccountReplicaEntry AWS API Documentation
|
|
557
|
+
#
|
|
558
|
+
class CrossAccountReplicaEntry < Struct.new(
|
|
559
|
+
:replica_secret_arn,
|
|
560
|
+
:replication_role_arn,
|
|
561
|
+
:replication_status,
|
|
562
|
+
:status_message)
|
|
563
|
+
SENSITIVE = []
|
|
564
|
+
include Aws::Structure
|
|
565
|
+
end
|
|
566
|
+
|
|
381
567
|
# Secrets Manager can't decrypt the protected secret text using the
|
|
382
568
|
# provided KMS key.
|
|
383
569
|
#
|
|
@@ -404,10 +590,18 @@ module Aws::SecretsManager
|
|
|
404
590
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
405
591
|
# @return [String]
|
|
406
592
|
#
|
|
593
|
+
# @!attribute [rw] policy_name
|
|
594
|
+
# The name of the resource policy to delete. If you don't specify
|
|
595
|
+
# this field, Secrets Manager uses `default`. You can only delete the
|
|
596
|
+
# `default` policy; if you specify any other name, the operation
|
|
597
|
+
# returns an `InvalidParameterException`.
|
|
598
|
+
# @return [String]
|
|
599
|
+
#
|
|
407
600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyRequest AWS API Documentation
|
|
408
601
|
#
|
|
409
602
|
class DeleteResourcePolicyRequest < Struct.new(
|
|
410
|
-
:secret_id
|
|
603
|
+
:secret_id,
|
|
604
|
+
:policy_name)
|
|
411
605
|
SENSITIVE = []
|
|
412
606
|
include Aws::Structure
|
|
413
607
|
end
|
|
@@ -422,11 +616,17 @@ module Aws::SecretsManager
|
|
|
422
616
|
# for.
|
|
423
617
|
# @return [String]
|
|
424
618
|
#
|
|
619
|
+
# @!attribute [rw] policy_name
|
|
620
|
+
# The name of the deleted resource policy. If you didn't specify
|
|
621
|
+
# `PolicyName` in the request, this is `default`.
|
|
622
|
+
# @return [String]
|
|
623
|
+
#
|
|
425
624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyResponse AWS API Documentation
|
|
426
625
|
#
|
|
427
626
|
class DeleteResourcePolicyResponse < Struct.new(
|
|
428
627
|
:arn,
|
|
429
|
-
:name
|
|
628
|
+
:name,
|
|
629
|
+
:policy_name)
|
|
430
630
|
SENSITIVE = []
|
|
431
631
|
include Aws::Structure
|
|
432
632
|
end
|
|
@@ -704,6 +904,20 @@ module Aws::SecretsManager
|
|
|
704
904
|
# * `InSync`, which indicates that the replica was created.
|
|
705
905
|
# @return [Array<Types::ReplicationStatusType>]
|
|
706
906
|
#
|
|
907
|
+
# @!attribute [rw] cross_account_primary
|
|
908
|
+
# Information about the primary secret in the other Amazon Web
|
|
909
|
+
# Services account that this cross-account replica secret replicates
|
|
910
|
+
# from, including the primary secret ARN and the replication status.
|
|
911
|
+
# This field is omitted if the secret is not a cross-account replica.
|
|
912
|
+
# @return [Types::CrossAccountPrimaryType]
|
|
913
|
+
#
|
|
914
|
+
# @!attribute [rw] cross_account_replicas
|
|
915
|
+
# A list of this secret's cross-account replica secrets and their
|
|
916
|
+
# replication status, if this secret is the primary for cross-account
|
|
917
|
+
# replication. This field is omitted if the secret has no
|
|
918
|
+
# cross-account replicas.
|
|
919
|
+
# @return [Array<Types::CrossAccountReplicaEntry>]
|
|
920
|
+
#
|
|
707
921
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretResponse AWS API Documentation
|
|
708
922
|
#
|
|
709
923
|
class DescribeSecretResponse < Struct.new(
|
|
@@ -727,7 +941,52 @@ module Aws::SecretsManager
|
|
|
727
941
|
:owning_service,
|
|
728
942
|
:created_date,
|
|
729
943
|
:primary_region,
|
|
730
|
-
:replication_status
|
|
944
|
+
:replication_status,
|
|
945
|
+
:cross_account_primary,
|
|
946
|
+
:cross_account_replicas)
|
|
947
|
+
SENSITIVE = []
|
|
948
|
+
include Aws::Structure
|
|
949
|
+
end
|
|
950
|
+
|
|
951
|
+
# @!attribute [rw] secret_id
|
|
952
|
+
# The ARN or name of the primary secret in your account.
|
|
953
|
+
#
|
|
954
|
+
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
955
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
956
|
+
#
|
|
957
|
+
#
|
|
958
|
+
#
|
|
959
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
960
|
+
# @return [String]
|
|
961
|
+
#
|
|
962
|
+
# @!attribute [rw] cross_account_replica_arn
|
|
963
|
+
# The ARN of the cross-account replica secret to unlink from the
|
|
964
|
+
# primary secret.
|
|
965
|
+
# @return [String]
|
|
966
|
+
#
|
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DisassociateCrossAccountReplicaRequest AWS API Documentation
|
|
968
|
+
#
|
|
969
|
+
class DisassociateCrossAccountReplicaRequest < Struct.new(
|
|
970
|
+
:secret_id,
|
|
971
|
+
:cross_account_replica_arn)
|
|
972
|
+
SENSITIVE = []
|
|
973
|
+
include Aws::Structure
|
|
974
|
+
end
|
|
975
|
+
|
|
976
|
+
# @!attribute [rw] arn
|
|
977
|
+
# The ARN of the primary secret.
|
|
978
|
+
# @return [String]
|
|
979
|
+
#
|
|
980
|
+
# @!attribute [rw] cross_account_replica_arn
|
|
981
|
+
# The ARN of the replica secret that was unlinked from the primary
|
|
982
|
+
# secret.
|
|
983
|
+
# @return [String]
|
|
984
|
+
#
|
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DisassociateCrossAccountReplicaResponse AWS API Documentation
|
|
986
|
+
#
|
|
987
|
+
class DisassociateCrossAccountReplicaResponse < Struct.new(
|
|
988
|
+
:arn,
|
|
989
|
+
:cross_account_replica_arn)
|
|
731
990
|
SENSITIVE = []
|
|
732
991
|
include Aws::Structure
|
|
733
992
|
end
|
|
@@ -903,10 +1162,18 @@ module Aws::SecretsManager
|
|
|
903
1162
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
904
1163
|
# @return [String]
|
|
905
1164
|
#
|
|
1165
|
+
# @!attribute [rw] policy_name
|
|
1166
|
+
# The name of the resource policy to retrieve. If you don't specify
|
|
1167
|
+
# this field, Secrets Manager uses `default`. If you specify a name
|
|
1168
|
+
# other than `default` and no policy with that name exists, the
|
|
1169
|
+
# operation returns a `ResourceNotFoundException`.
|
|
1170
|
+
# @return [String]
|
|
1171
|
+
#
|
|
906
1172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyRequest AWS API Documentation
|
|
907
1173
|
#
|
|
908
1174
|
class GetResourcePolicyRequest < Struct.new(
|
|
909
|
-
:secret_id
|
|
1175
|
+
:secret_id,
|
|
1176
|
+
:policy_name)
|
|
910
1177
|
SENSITIVE = []
|
|
911
1178
|
include Aws::Structure
|
|
912
1179
|
end
|
|
@@ -932,12 +1199,18 @@ module Aws::SecretsManager
|
|
|
932
1199
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
933
1200
|
# @return [String]
|
|
934
1201
|
#
|
|
1202
|
+
# @!attribute [rw] policy_name
|
|
1203
|
+
# The name of the resource policy. If you didn't specify `PolicyName`
|
|
1204
|
+
# in the request, this is `default`.
|
|
1205
|
+
# @return [String]
|
|
1206
|
+
#
|
|
935
1207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyResponse AWS API Documentation
|
|
936
1208
|
#
|
|
937
1209
|
class GetResourcePolicyResponse < Struct.new(
|
|
938
1210
|
:arn,
|
|
939
1211
|
:name,
|
|
940
|
-
:resource_policy
|
|
1212
|
+
:resource_policy,
|
|
1213
|
+
:policy_name)
|
|
941
1214
|
SENSITIVE = []
|
|
942
1215
|
include Aws::Structure
|
|
943
1216
|
end
|
|
@@ -1140,6 +1413,61 @@ module Aws::SecretsManager
|
|
|
1140
1413
|
include Aws::Structure
|
|
1141
1414
|
end
|
|
1142
1415
|
|
|
1416
|
+
# @!attribute [rw] secret_id
|
|
1417
|
+
# The ARN or name of the secret.
|
|
1418
|
+
#
|
|
1419
|
+
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1420
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1421
|
+
#
|
|
1422
|
+
#
|
|
1423
|
+
#
|
|
1424
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1425
|
+
# @return [String]
|
|
1426
|
+
#
|
|
1427
|
+
# @!attribute [rw] max_results
|
|
1428
|
+
# The number of results to include in the response. If you don't
|
|
1429
|
+
# specify this value, the service returns up to 100 results.
|
|
1430
|
+
#
|
|
1431
|
+
# If there are more results available, in the response, Secrets
|
|
1432
|
+
# Manager includes `NextToken`. To get the next results, call
|
|
1433
|
+
# `ListResourcePolicies` again with the value from `NextToken`.
|
|
1434
|
+
# @return [Integer]
|
|
1435
|
+
#
|
|
1436
|
+
# @!attribute [rw] next_token
|
|
1437
|
+
# A token that indicates where the output should continue from, if a
|
|
1438
|
+
# previous call did not show all results. To get the next results,
|
|
1439
|
+
# call `ListResourcePolicies` again with this value.
|
|
1440
|
+
# @return [String]
|
|
1441
|
+
#
|
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListResourcePoliciesRequest AWS API Documentation
|
|
1443
|
+
#
|
|
1444
|
+
class ListResourcePoliciesRequest < Struct.new(
|
|
1445
|
+
:secret_id,
|
|
1446
|
+
:max_results,
|
|
1447
|
+
:next_token)
|
|
1448
|
+
SENSITIVE = []
|
|
1449
|
+
include Aws::Structure
|
|
1450
|
+
end
|
|
1451
|
+
|
|
1452
|
+
# @!attribute [rw] resource_policies
|
|
1453
|
+
# A list of the resource policies attached to the secret.
|
|
1454
|
+
# @return [Array<Types::ResourcePolicySummary>]
|
|
1455
|
+
#
|
|
1456
|
+
# @!attribute [rw] next_token
|
|
1457
|
+
# Secrets Manager includes this value if there's more output
|
|
1458
|
+
# available than what is included in the current response. To get the
|
|
1459
|
+
# next results, call `ListResourcePolicies` again with this value.
|
|
1460
|
+
# @return [String]
|
|
1461
|
+
#
|
|
1462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListResourcePoliciesResponse AWS API Documentation
|
|
1463
|
+
#
|
|
1464
|
+
class ListResourcePoliciesResponse < Struct.new(
|
|
1465
|
+
:resource_policies,
|
|
1466
|
+
:next_token)
|
|
1467
|
+
SENSITIVE = []
|
|
1468
|
+
include Aws::Structure
|
|
1469
|
+
end
|
|
1470
|
+
|
|
1143
1471
|
# @!attribute [rw] secret_id
|
|
1144
1472
|
# The ARN or name of the secret whose versions you want to list.
|
|
1145
1473
|
#
|
|
@@ -1341,6 +1669,13 @@ module Aws::SecretsManager
|
|
|
1341
1669
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html
|
|
1342
1670
|
# @return [String]
|
|
1343
1671
|
#
|
|
1672
|
+
# @!attribute [rw] policy_name
|
|
1673
|
+
# The name of the resource policy to attach. If you don't specify
|
|
1674
|
+
# this field, Secrets Manager uses `default`. You can only attach the
|
|
1675
|
+
# `default` policy; if you specify any other name, the operation
|
|
1676
|
+
# returns an `InvalidParameterException`.
|
|
1677
|
+
# @return [String]
|
|
1678
|
+
#
|
|
1344
1679
|
# @!attribute [rw] block_public_policy
|
|
1345
1680
|
# Specifies whether to block resource-based policies that allow broad
|
|
1346
1681
|
# access to the secret, for example those that use a wildcard for the
|
|
@@ -1373,6 +1708,7 @@ module Aws::SecretsManager
|
|
|
1373
1708
|
class PutResourcePolicyRequest < Struct.new(
|
|
1374
1709
|
:secret_id,
|
|
1375
1710
|
:resource_policy,
|
|
1711
|
+
:policy_name,
|
|
1376
1712
|
:block_public_policy)
|
|
1377
1713
|
SENSITIVE = []
|
|
1378
1714
|
include Aws::Structure
|
|
@@ -1386,11 +1722,17 @@ module Aws::SecretsManager
|
|
|
1386
1722
|
# The name of the secret.
|
|
1387
1723
|
# @return [String]
|
|
1388
1724
|
#
|
|
1725
|
+
# @!attribute [rw] policy_name
|
|
1726
|
+
# The name of the resource policy. If you didn't specify `PolicyName`
|
|
1727
|
+
# in the request, this is `default`.
|
|
1728
|
+
# @return [String]
|
|
1729
|
+
#
|
|
1389
1730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyResponse AWS API Documentation
|
|
1390
1731
|
#
|
|
1391
1732
|
class PutResourcePolicyResponse < Struct.new(
|
|
1392
1733
|
:arn,
|
|
1393
|
-
:name
|
|
1734
|
+
:name,
|
|
1735
|
+
:policy_name)
|
|
1394
1736
|
SENSITIVE = []
|
|
1395
1737
|
include Aws::Structure
|
|
1396
1738
|
end
|
|
@@ -1725,6 +2067,26 @@ module Aws::SecretsManager
|
|
|
1725
2067
|
include Aws::Structure
|
|
1726
2068
|
end
|
|
1727
2069
|
|
|
2070
|
+
# A structure that contains details about a resource policy attached to
|
|
2071
|
+
# a secret. It does not contain the contents of the resource policy. To
|
|
2072
|
+
# view the contents of the policy, use [GetResourcePolicy][1] .
|
|
2073
|
+
#
|
|
2074
|
+
#
|
|
2075
|
+
#
|
|
2076
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetResourcePolicy.html
|
|
2077
|
+
#
|
|
2078
|
+
# @!attribute [rw] policy_name
|
|
2079
|
+
# The name of the resource policy.
|
|
2080
|
+
# @return [String]
|
|
2081
|
+
#
|
|
2082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ResourcePolicySummary AWS API Documentation
|
|
2083
|
+
#
|
|
2084
|
+
class ResourcePolicySummary < Struct.new(
|
|
2085
|
+
:policy_name)
|
|
2086
|
+
SENSITIVE = []
|
|
2087
|
+
include Aws::Structure
|
|
2088
|
+
end
|
|
2089
|
+
|
|
1728
2090
|
# @!attribute [rw] secret_id
|
|
1729
2091
|
# The ARN or name of the secret to restore.
|
|
1730
2092
|
#
|
|
@@ -2256,9 +2618,12 @@ module Aws::SecretsManager
|
|
|
2256
2618
|
end
|
|
2257
2619
|
|
|
2258
2620
|
# @!attribute [rw] secret_id
|
|
2259
|
-
# The name of the
|
|
2260
|
-
#
|
|
2261
|
-
#
|
|
2621
|
+
# The ARN or name of the replica secret.
|
|
2622
|
+
#
|
|
2623
|
+
# For a cross-region replica, the replica ARN is the same as the
|
|
2624
|
+
# original primary secret ARN except that the Region is changed to the
|
|
2625
|
+
# replica Region. For a cross-account replica, this is the ARN or name
|
|
2626
|
+
# of the replica secret in your account.
|
|
2262
2627
|
# @return [String]
|
|
2263
2628
|
#
|
|
2264
2629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/StopReplicationToReplicaRequest AWS API Documentation
|
|
@@ -2270,8 +2635,10 @@ module Aws::SecretsManager
|
|
|
2270
2635
|
end
|
|
2271
2636
|
|
|
2272
2637
|
# @!attribute [rw] arn
|
|
2273
|
-
# The ARN of the promoted secret.
|
|
2274
|
-
# primary secret except the
|
|
2638
|
+
# The ARN of the promoted secret. For a cross-region replica, this ARN
|
|
2639
|
+
# is the same as the original primary secret's ARN except that the
|
|
2640
|
+
# Region is changed. For a cross-account replica, this is the ARN of
|
|
2641
|
+
# the promoted secret in your account.
|
|
2275
2642
|
# @return [String]
|
|
2276
2643
|
#
|
|
2277
2644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/StopReplicationToReplicaResponse AWS API Documentation
|
|
@@ -23,7 +23,7 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:secretsmanager)
|
|
|
23
23
|
# structure.
|
|
24
24
|
#
|
|
25
25
|
# secrets_manager = Aws::SecretsManager::Client.new
|
|
26
|
-
# resp = secrets_manager.
|
|
26
|
+
# resp = secrets_manager.associate_cross_account_replica(params)
|
|
27
27
|
#
|
|
28
28
|
# See {Client} for more information.
|
|
29
29
|
#
|
|
@@ -54,7 +54,7 @@ module Aws::SecretsManager
|
|
|
54
54
|
autoload :EndpointProvider, 'aws-sdk-secretsmanager/endpoint_provider'
|
|
55
55
|
autoload :Endpoints, 'aws-sdk-secretsmanager/endpoints'
|
|
56
56
|
|
|
57
|
-
GEM_VERSION = '1.
|
|
57
|
+
GEM_VERSION = '1.147.0'
|
|
58
58
|
|
|
59
59
|
end
|
|
60
60
|
|
data/sig/client.rbs
CHANGED
|
@@ -80,6 +80,21 @@ module Aws
|
|
|
80
80
|
| (?Hash[Symbol, untyped]) -> instance
|
|
81
81
|
|
|
82
82
|
|
|
83
|
+
interface _AssociateCrossAccountReplicaResponseSuccess
|
|
84
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AssociateCrossAccountReplicaResponse]
|
|
85
|
+
def arn: () -> ::String
|
|
86
|
+
def cross_account_replica_arn: () -> ::String
|
|
87
|
+
def replication_status: () -> ("InSync" | "Failed" | "InProgress" | "Pending" | "Detached")
|
|
88
|
+
end
|
|
89
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#associate_cross_account_replica-instance_method
|
|
90
|
+
def associate_cross_account_replica: (
|
|
91
|
+
secret_id: ::String,
|
|
92
|
+
cross_account_replica_arn: ::String,
|
|
93
|
+
?replica_restriction: ("SameOrg" | "NoRestriction"),
|
|
94
|
+
?replication_role_arn: ::String
|
|
95
|
+
) -> _AssociateCrossAccountReplicaResponseSuccess
|
|
96
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateCrossAccountReplicaResponseSuccess
|
|
97
|
+
|
|
83
98
|
interface _BatchGetSecretValueResponseSuccess
|
|
84
99
|
include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetSecretValueResponse]
|
|
85
100
|
def secret_values: () -> ::Array[Types::SecretValueEntry]
|
|
@@ -140,7 +155,8 @@ module Aws
|
|
|
140
155
|
}
|
|
141
156
|
],
|
|
142
157
|
?force_overwrite_replica_secret: bool,
|
|
143
|
-
?type: ::String
|
|
158
|
+
?type: ::String,
|
|
159
|
+
?cross_account_primary_arn: ::String
|
|
144
160
|
) -> _CreateSecretResponseSuccess
|
|
145
161
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSecretResponseSuccess
|
|
146
162
|
|
|
@@ -148,10 +164,12 @@ module Aws
|
|
|
148
164
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteResourcePolicyResponse]
|
|
149
165
|
def arn: () -> ::String
|
|
150
166
|
def name: () -> ::String
|
|
167
|
+
def policy_name: () -> ::String
|
|
151
168
|
end
|
|
152
169
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#delete_resource_policy-instance_method
|
|
153
170
|
def delete_resource_policy: (
|
|
154
|
-
secret_id: ::String
|
|
171
|
+
secret_id: ::String,
|
|
172
|
+
?policy_name: ::String
|
|
155
173
|
) -> _DeleteResourcePolicyResponseSuccess
|
|
156
174
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteResourcePolicyResponseSuccess
|
|
157
175
|
|
|
@@ -192,6 +210,8 @@ module Aws
|
|
|
192
210
|
def created_date: () -> ::Time
|
|
193
211
|
def primary_region: () -> ::String
|
|
194
212
|
def replication_status: () -> ::Array[Types::ReplicationStatusType]
|
|
213
|
+
def cross_account_primary: () -> Types::CrossAccountPrimaryType
|
|
214
|
+
def cross_account_replicas: () -> ::Array[Types::CrossAccountReplicaEntry]
|
|
195
215
|
end
|
|
196
216
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#describe_secret-instance_method
|
|
197
217
|
def describe_secret: (
|
|
@@ -199,6 +219,18 @@ module Aws
|
|
|
199
219
|
) -> _DescribeSecretResponseSuccess
|
|
200
220
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeSecretResponseSuccess
|
|
201
221
|
|
|
222
|
+
interface _DisassociateCrossAccountReplicaResponseSuccess
|
|
223
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateCrossAccountReplicaResponse]
|
|
224
|
+
def arn: () -> ::String
|
|
225
|
+
def cross_account_replica_arn: () -> ::String
|
|
226
|
+
end
|
|
227
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#disassociate_cross_account_replica-instance_method
|
|
228
|
+
def disassociate_cross_account_replica: (
|
|
229
|
+
secret_id: ::String,
|
|
230
|
+
cross_account_replica_arn: ::String
|
|
231
|
+
) -> _DisassociateCrossAccountReplicaResponseSuccess
|
|
232
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateCrossAccountReplicaResponseSuccess
|
|
233
|
+
|
|
202
234
|
interface _GetRandomPasswordResponseSuccess
|
|
203
235
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetRandomPasswordResponse]
|
|
204
236
|
def random_password: () -> ::String
|
|
@@ -221,10 +253,12 @@ module Aws
|
|
|
221
253
|
def arn: () -> ::String
|
|
222
254
|
def name: () -> ::String
|
|
223
255
|
def resource_policy: () -> ::String
|
|
256
|
+
def policy_name: () -> ::String
|
|
224
257
|
end
|
|
225
258
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#get_resource_policy-instance_method
|
|
226
259
|
def get_resource_policy: (
|
|
227
|
-
secret_id: ::String
|
|
260
|
+
secret_id: ::String,
|
|
261
|
+
?policy_name: ::String
|
|
228
262
|
) -> _GetResourcePolicyResponseSuccess
|
|
229
263
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcePolicyResponseSuccess
|
|
230
264
|
|
|
@@ -246,6 +280,19 @@ module Aws
|
|
|
246
280
|
) -> _GetSecretValueResponseSuccess
|
|
247
281
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSecretValueResponseSuccess
|
|
248
282
|
|
|
283
|
+
interface _ListResourcePoliciesResponseSuccess
|
|
284
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListResourcePoliciesResponse]
|
|
285
|
+
def resource_policies: () -> ::Array[Types::ResourcePolicySummary]
|
|
286
|
+
def next_token: () -> ::String
|
|
287
|
+
end
|
|
288
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#list_resource_policies-instance_method
|
|
289
|
+
def list_resource_policies: (
|
|
290
|
+
secret_id: ::String,
|
|
291
|
+
?max_results: ::Integer,
|
|
292
|
+
?next_token: ::String
|
|
293
|
+
) -> _ListResourcePoliciesResponseSuccess
|
|
294
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListResourcePoliciesResponseSuccess
|
|
295
|
+
|
|
249
296
|
interface _ListSecretVersionIdsResponseSuccess
|
|
250
297
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListSecretVersionIdsResponse]
|
|
251
298
|
def versions: () -> ::Array[Types::SecretVersionsListEntry]
|
|
@@ -287,11 +334,13 @@ module Aws
|
|
|
287
334
|
include ::Seahorse::Client::_ResponseSuccess[Types::PutResourcePolicyResponse]
|
|
288
335
|
def arn: () -> ::String
|
|
289
336
|
def name: () -> ::String
|
|
337
|
+
def policy_name: () -> ::String
|
|
290
338
|
end
|
|
291
339
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecretsManager/Client.html#put_resource_policy-instance_method
|
|
292
340
|
def put_resource_policy: (
|
|
293
341
|
secret_id: ::String,
|
|
294
342
|
resource_policy: ::String,
|
|
343
|
+
?policy_name: ::String,
|
|
295
344
|
?block_public_policy: bool
|
|
296
345
|
) -> _PutResourcePolicyResponseSuccess
|
|
297
346
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutResourcePolicyResponseSuccess
|