« blib/lib/Paws/AppSync/AdditionalAuthenticationProvider.pm
↑ Summary
blib/lib/Paws/AppSync/ApiKey.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppSync::ApiCache; | ||
| 3 | use Moose; | ||
| 4 | has ApiCachingBehavior => (is => 'ro', isa => 'Str', request_name => 'apiCachingBehavior', traits => ['NameInRequest']); | ||
| 5 | has AtRestEncryptionEnabled => (is => 'ro', isa => 'Bool', request_name => 'atRestEncryptionEnabled', traits => ['NameInRequest']); | ||
| 6 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 7 | has TransitEncryptionEnabled => (is => 'ro', isa => 'Bool', request_name => 'transitEncryptionEnabled', traits => ['NameInRequest']); | ||
| 8 | has Ttl => (is => 'ro', isa => 'Int', request_name => 'ttl', traits => ['NameInRequest']); | ||
| 9 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::AppSync::ApiCache | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::AppSync::ApiCache object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ApiCachingBehavior => $value, ..., Type => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppSync::ApiCache object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ApiCachingBehavior | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The C<ApiCache> object. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ApiCachingBehavior => Str | ||
| 47 | |||
| 48 | Caching behavior. | ||
| 49 | |||
| 50 | =over | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | B<FULL_REQUEST_CACHING>: All requests are fully cached. | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | B<PER_RESOLVER_CACHING>: Individual resolvers that you specify are | ||
| 59 | cached. | ||
| 60 | |||
| 61 | =back | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 AtRestEncryptionEnabled => Bool | ||
| 66 | |||
| 67 | At rest encryption flag for cache. This setting cannot be updated after | ||
| 68 | creation. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Status => Str | ||
| 72 | |||
| 73 | The cache instance status. | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | B<AVAILABLE>: The instance is available for use. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | B<CREATING>: The instance is currently creating. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | B<DELETING>: The instance is currently deleting. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | B<MODIFYING>: The instance is currently modifying. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | B<FAILED>: The instance has failed creation. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 TransitEncryptionEnabled => Bool | ||
| 102 | |||
| 103 | Transit encryption flag when connecting to cache. This setting cannot | ||
| 104 | be updated after creation. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Ttl => Int | ||
| 108 | |||
| 109 | TTL in seconds for cache entries. | ||
| 110 | |||
| 111 | Valid values are between 1 and 3600 seconds. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Type => Str | ||
| 115 | |||
| 116 | The cache instance type. Valid values are | ||
| 117 | |||
| 118 | =over | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<SMALL> | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<MEDIUM> | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | C<LARGE> | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | C<XLARGE> | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<LARGE_2X> | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<LARGE_4X> | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | C<LARGE_8X> (not available in all regions) | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<LARGE_12X> | ||
| 151 | |||
| 152 | =back | ||
| 153 | |||
| 154 | Historically, instance types were identified by an EC2-style value. As | ||
| 155 | of July 2020, this is deprecated, and the generic identifiers above | ||
| 156 | should be used. | ||
| 157 | |||
| 158 | The following legacy instance types are available, but their use is | ||
| 159 | discouraged: | ||
| 160 | |||
| 161 | =over | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | B<T2_SMALL>: A t2.small instance type. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | B<T2_MEDIUM>: A t2.medium instance type. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | B<R4_LARGE>: A r4.large instance type. | ||
| 174 | |||
| 175 | =item * | ||
| 176 | |||
| 177 | B<R4_XLARGE>: A r4.xlarge instance type. | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | B<R4_2XLARGE>: A r4.2xlarge instance type. | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | B<R4_4XLARGE>: A r4.4xlarge instance type. | ||
| 186 | |||
| 187 | =item * | ||
| 188 | |||
| 189 | B<R4_8XLARGE>: A r4.8xlarge instance type. | ||
| 190 | |||
| 191 | =back | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head1 SEE ALSO | ||
| 197 | |||
| 198 | This class forms part of L<Paws>, describing an object used in L<Paws::AppSync> | ||
| 199 | |||
| 200 | =head1 BUGS and CONTRIBUTIONS | ||
| 201 | |||
| 202 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 203 | |||
| 204 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 205 | |||
| 206 | =cut | ||
| 207 |