« blib/lib/Paws/AccessAnalyzer/ConfigurationsMap.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/CreateAccessPreviewResponse.pm »
| 1 | |||
| 2 | package Paws::AccessAnalyzer::CreateAccessPreview; | ||
| 3 | use Moose; | ||
| 4 | has AnalyzerArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'analyzerArn', required => 1); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 6 | has Configurations => (is => 'ro', isa => 'Paws::AccessAnalyzer::ConfigurationsMap', traits => ['NameInRequest'], request_name => 'configurations', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAccessPreview'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/access-preview'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AccessAnalyzer::CreateAccessPreviewResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AccessAnalyzer::CreateAccessPreview - Arguments for method CreateAccessPreview on L<Paws::AccessAnalyzer> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateAccessPreview on the | ||
| 25 | L<Access Analyzer|Paws::AccessAnalyzer> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateAccessPreview. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAccessPreview. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $access-analyzer = Paws->service('AccessAnalyzer'); | ||
| 33 | my $CreateAccessPreviewResponse = $access -analyzer->CreateAccessPreview( | ||
| 34 | AnalyzerArn => 'MyAnalyzerArn', | ||
| 35 | Configurations => { | ||
| 36 | 'MyConfigurationsMapKey' => { | ||
| 37 | IamRole => { | ||
| 38 | TrustPolicy => 'MyIamTrustPolicy', # OPTIONAL | ||
| 39 | }, # OPTIONAL | ||
| 40 | KmsKey => { | ||
| 41 | Grants => [ | ||
| 42 | { | ||
| 43 | GranteePrincipal => 'MyGranteePrincipal', | ||
| 44 | IssuingAccount => 'MyIssuingAccount', | ||
| 45 | Operations => [ | ||
| 46 | 'CreateGrant', | ||
| 47 | ... # values: CreateGrant, Decrypt, DescribeKey, Encrypt, GenerateDataKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GenerateDataKeyWithoutPlaintext, GetPublicKey, ReEncryptFrom, ReEncryptTo, RetireGrant, Sign, Verify | ||
| 48 | ], | ||
| 49 | Constraints => { | ||
| 50 | EncryptionContextEquals => | ||
| 51 | { 'MyKmsConstraintsKey' => 'MyKmsConstraintsValue', } | ||
| 52 | , # OPTIONAL | ||
| 53 | EncryptionContextSubset => | ||
| 54 | { 'MyKmsConstraintsKey' => 'MyKmsConstraintsValue', } | ||
| 55 | , # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | RetiringPrincipal => 'MyRetiringPrincipal', # OPTIONAL | ||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | KeyPolicies => { 'MyPolicyName' => 'MyKmsKeyPolicy', }, # OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | S3Bucket => { | ||
| 64 | AccessPoints => { | ||
| 65 | 'MyAccessPointArn' => { | ||
| 66 | AccessPointPolicy => 'MyAccessPointPolicy', # OPTIONAL | ||
| 67 | NetworkOrigin => { | ||
| 68 | InternetConfiguration => { | ||
| 69 | |||
| 70 | }, # OPTIONAL | ||
| 71 | VpcConfiguration => { | ||
| 72 | VpcId => 'MyVpcId', | ||
| 73 | |||
| 74 | }, # OPTIONAL | ||
| 75 | }, # OPTIONAL | ||
| 76 | PublicAccessBlock => { | ||
| 77 | IgnorePublicAcls => 1, | ||
| 78 | RestrictPublicBuckets => 1, | ||
| 79 | |||
| 80 | }, # OPTIONAL | ||
| 81 | }, | ||
| 82 | }, # OPTIONAL | ||
| 83 | BucketAclGrants => [ | ||
| 84 | { | ||
| 85 | Grantee => { | ||
| 86 | Id => 'MyAclCanonicalId', # OPTIONAL | ||
| 87 | Uri => 'MyAclUri', # OPTIONAL | ||
| 88 | }, | ||
| 89 | Permission => 'READ' | ||
| 90 | , # values: READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL | ||
| 91 | |||
| 92 | }, | ||
| 93 | ... | ||
| 94 | ], # OPTIONAL | ||
| 95 | BucketPolicy => 'MyS3BucketPolicy', # OPTIONAL | ||
| 96 | BucketPublicAccessBlock => { | ||
| 97 | IgnorePublicAcls => 1, | ||
| 98 | RestrictPublicBuckets => 1, | ||
| 99 | |||
| 100 | }, # OPTIONAL | ||
| 101 | }, # OPTIONAL | ||
| 102 | SecretsManagerSecret => { | ||
| 103 | KmsKeyId => 'MySecretsManagerSecretKmsId', # OPTIONAL | ||
| 104 | SecretPolicy => 'MySecretsManagerSecretPolicy', # OPTIONAL | ||
| 105 | }, # OPTIONAL | ||
| 106 | SqsQueue => { | ||
| 107 | QueuePolicy => 'MySqsQueuePolicy', # OPTIONAL | ||
| 108 | }, # OPTIONAL | ||
| 109 | }, | ||
| 110 | }, | ||
| 111 | ClientToken => 'MyString', # OPTIONAL | ||
| 112 | ); | ||
| 113 | |||
| 114 | # Results: | ||
| 115 | my $Id = $CreateAccessPreviewResponse->Id; | ||
| 116 | |||
| 117 | # Returns a L<Paws::AccessAnalyzer::CreateAccessPreviewResponse> object. | ||
| 118 | |||
| 119 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 120 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/access-analyzer/CreateAccessPreview> | ||
| 121 | |||
| 122 | =head1 ATTRIBUTES | ||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> AnalyzerArn => Str | ||
| 126 | |||
| 127 | The ARN of the account analyzer | ||
| 128 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) | ||
| 129 | used to generate the access preview. You can only create an access | ||
| 130 | preview for analyzers with an C<Account> type and C<Active> status. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 ClientToken => Str | ||
| 135 | |||
| 136 | A client token. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> Configurations => L<Paws::AccessAnalyzer::ConfigurationsMap> | ||
| 141 | |||
| 142 | Access control configuration for your resource that is used to generate | ||
| 143 | the access preview. The access preview includes findings for external | ||
| 144 | access allowed to the resource with the proposed access control | ||
| 145 | configuration. The configuration must contain exactly one element. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method CreateAccessPreview in L<Paws::AccessAnalyzer> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |