« blib/lib/Paws/SMS/CreateAppResponse.pm
↑ Summary
blib/lib/Paws/SMS/CreateReplicationJobResponse.pm »
| 1 | |||
| 2 | package Paws::SMS::CreateReplicationJob; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 5 | has Encrypted => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'encrypted' ); | ||
| 6 | has Frequency => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'frequency' ); | ||
| 7 | has KmsKeyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsKeyId' ); | ||
| 8 | has LicenseType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'licenseType' ); | ||
| 9 | has NumberOfRecentAmisToKeep => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'numberOfRecentAmisToKeep' ); | ||
| 10 | has RoleName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleName' ); | ||
| 11 | has RunOnce => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'runOnce' ); | ||
| 12 | has SeedReplicationTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'seedReplicationTime' , required => 1); | ||
| 13 | has ServerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serverId' , required => 1); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateReplicationJob'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SMS::CreateReplicationJobResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::SMS::CreateReplicationJob - Arguments for method CreateReplicationJob on L<Paws::SMS> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateReplicationJob on the | ||
| 31 | L<AWS Server Migration Service|Paws::SMS> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateReplicationJob. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationJob. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $sms = Paws->service('SMS'); | ||
| 39 | my $CreateReplicationJobResponse = $sms->CreateReplicationJob( | ||
| 40 | SeedReplicationTime => '1970-01-01T01:00:00', | ||
| 41 | ServerId => 'MyServerId', | ||
| 42 | Description => 'MyDescription', # OPTIONAL | ||
| 43 | Encrypted => 1, # OPTIONAL | ||
| 44 | Frequency => 1, # OPTIONAL | ||
| 45 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 46 | LicenseType => 'AWS', # OPTIONAL | ||
| 47 | NumberOfRecentAmisToKeep => 1, # OPTIONAL | ||
| 48 | RoleName => 'MyRoleName', # OPTIONAL | ||
| 49 | RunOnce => 1, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $ReplicationJobId = $CreateReplicationJobResponse->ReplicationJobId; | ||
| 54 | |||
| 55 | # Returns a L<Paws::SMS::CreateReplicationJobResponse> 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/sms/CreateReplicationJob> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Description => Str | ||
| 64 | |||
| 65 | The description of the replication job. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Encrypted => Bool | ||
| 70 | |||
| 71 | Indicates whether the replication job produces encrypted AMIs. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Frequency => Int | ||
| 76 | |||
| 77 | The time between consecutive replication runs, in hours. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 KmsKeyId => Str | ||
| 82 | |||
| 83 | The ID of the KMS key for replication jobs that produce encrypted AMIs. | ||
| 84 | This value can be any of the following: | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | KMS key ID | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | KMS key alias | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | ARN referring to the KMS key ID | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | ARN referring to the KMS key alias | ||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | If encrypted is I<true> but a KMS key ID is not specified, the | ||
| 107 | customer's default KMS key for Amazon EBS is used. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 LicenseType => Str | ||
| 112 | |||
| 113 | The license type to be used for the AMI created by a successful | ||
| 114 | replication run. | ||
| 115 | |||
| 116 | Valid values are: C<"AWS">, C<"BYOL"> | ||
| 117 | |||
| 118 | =head2 NumberOfRecentAmisToKeep => Int | ||
| 119 | |||
| 120 | The maximum number of SMS-created AMIs to retain. The oldest is deleted | ||
| 121 | after the maximum number is reached and a new AMI is created. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 RoleName => Str | ||
| 126 | |||
| 127 | The name of the IAM role to be used by the AWS SMS. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 RunOnce => Bool | ||
| 132 | |||
| 133 | Indicates whether to run the replication job one time. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> SeedReplicationTime => Str | ||
| 138 | |||
| 139 | The seed replication time. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 B<REQUIRED> ServerId => Str | ||
| 144 | |||
| 145 | The ID of the server. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method CreateReplicationJob in L<Paws::SMS> | ||
| 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 |