« blib/lib/Paws/DMS/StartReplicationTaskAssessmentResponse.pm
↑ Summary
blib/lib/Paws/DMS/StartReplicationTaskAssessmentRunResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::StartReplicationTaskAssessmentRun; | ||
| 3 | use Moose; | ||
| 4 | has AssessmentRunName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Exclude => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has IncludeOnly => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has ReplicationTaskArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ResultEncryptionMode => (is => 'ro', isa => 'Str'); | ||
| 9 | has ResultKmsKeyArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has ResultLocationBucket => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has ResultLocationFolder => (is => 'ro', isa => 'Str'); | ||
| 12 | has ServiceAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartReplicationTaskAssessmentRun'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::StartReplicationTaskAssessmentRunResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::DMS::StartReplicationTaskAssessmentRun - Arguments for method StartReplicationTaskAssessmentRun on L<Paws::DMS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method StartReplicationTaskAssessmentRun on the | ||
| 30 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 31 | as arguments to method StartReplicationTaskAssessmentRun. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartReplicationTaskAssessmentRun. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $dms = Paws->service('DMS'); | ||
| 38 | my $StartReplicationTaskAssessmentRunResponse = | ||
| 39 | $dms->StartReplicationTaskAssessmentRun( | ||
| 40 | AssessmentRunName => 'MyString', | ||
| 41 | ReplicationTaskArn => 'MyString', | ||
| 42 | ResultLocationBucket => 'MyString', | ||
| 43 | ServiceAccessRoleArn => 'MyString', | ||
| 44 | Exclude => [ 'MyString', ... ], # OPTIONAL | ||
| 45 | IncludeOnly => [ 'MyString', ... ], # OPTIONAL | ||
| 46 | ResultEncryptionMode => 'MyString', # OPTIONAL | ||
| 47 | ResultKmsKeyArn => 'MyString', # OPTIONAL | ||
| 48 | ResultLocationFolder => 'MyString', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $ReplicationTaskAssessmentRun = | ||
| 53 | $StartReplicationTaskAssessmentRunResponse->ReplicationTaskAssessmentRun; | ||
| 54 | |||
| 55 | # Returns a L<Paws::DMS::StartReplicationTaskAssessmentRunResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/StartReplicationTaskAssessmentRun> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> AssessmentRunName => Str | ||
| 64 | |||
| 65 | Unique name to identify the assessment run. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Exclude => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | Space-separated list of names for specific individual assessments that | ||
| 72 | you want to exclude. These names come from the default list of | ||
| 73 | individual assessments that AWS DMS supports for the associated | ||
| 74 | migration task. This task is specified by C<ReplicationTaskArn>. | ||
| 75 | |||
| 76 | You can't set a value for C<Exclude> if you also set a value for | ||
| 77 | C<IncludeOnly> in the API operation. | ||
| 78 | |||
| 79 | To identify the names of the default individual assessments that AWS | ||
| 80 | DMS supports for the associated migration task, run the | ||
| 81 | C<DescribeApplicableIndividualAssessments> operation using its own | ||
| 82 | C<ReplicationTaskArn> request parameter. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 IncludeOnly => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | Space-separated list of names for specific individual assessments that | ||
| 89 | you want to include. These names come from the default list of | ||
| 90 | individual assessments that AWS DMS supports for the associated | ||
| 91 | migration task. This task is specified by C<ReplicationTaskArn>. | ||
| 92 | |||
| 93 | You can't set a value for C<IncludeOnly> if you also set a value for | ||
| 94 | C<Exclude> in the API operation. | ||
| 95 | |||
| 96 | To identify the names of the default individual assessments that AWS | ||
| 97 | DMS supports for the associated migration task, run the | ||
| 98 | C<DescribeApplicableIndividualAssessments> operation using its own | ||
| 99 | C<ReplicationTaskArn> request parameter. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> ReplicationTaskArn => Str | ||
| 104 | |||
| 105 | Amazon Resource Name (ARN) of the migration task associated with the | ||
| 106 | premigration assessment run that you want to start. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 ResultEncryptionMode => Str | ||
| 111 | |||
| 112 | Encryption mode that you can specify to encrypt the results of this | ||
| 113 | assessment run. If you don't specify this request parameter, AWS DMS | ||
| 114 | stores the assessment run results without encryption. You can specify | ||
| 115 | one of the options following: | ||
| 116 | |||
| 117 | =over | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<"SSE_S3"> E<ndash> The server-side encryption provided as a default | ||
| 122 | by Amazon S3. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<"SSE_KMS"> E<ndash> AWS Key Management Service (AWS KMS) encryption. | ||
| 127 | This encryption can use either a custom KMS encryption key that you | ||
| 128 | specify or the default KMS encryption key that DMS provides. | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 ResultKmsKeyArn => Str | ||
| 136 | |||
| 137 | ARN of a custom KMS encryption key that you specify when you set | ||
| 138 | C<ResultEncryptionMode> to C<"SSE_KMS>". | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> ResultLocationBucket => Str | ||
| 143 | |||
| 144 | Amazon S3 bucket where you want AWS DMS to store the results of this | ||
| 145 | assessment run. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 ResultLocationFolder => Str | ||
| 150 | |||
| 151 | Folder within an Amazon S3 bucket where you want AWS DMS to store the | ||
| 152 | results of this assessment run. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 B<REQUIRED> ServiceAccessRoleArn => Str | ||
| 157 | |||
| 158 | ARN of a service role needed to start the assessment run. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head1 SEE ALSO | ||
| 164 | |||
| 165 | This class forms part of L<Paws>, documenting arguments for method StartReplicationTaskAssessmentRun in L<Paws::DMS> | ||
| 166 | |||
| 167 | =head1 BUGS and CONTRIBUTIONS | ||
| 168 | |||
| 169 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 170 | |||
| 171 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 172 | |||
| 173 | =cut | ||
| 174 |