« blib/lib/Paws/AppSync/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/AppSync/UpdateApiCacheResponse.pm »
| 1 | |||
| 2 | package Paws::AppSync::UpdateApiCache; | ||
| 3 | use Moose; | ||
| 4 | has ApiCachingBehavior => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'apiCachingBehavior', required => 1); | ||
| 5 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 6 | has Ttl => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'ttl', required => 1); | ||
| 7 | has Type => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'type', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateApiCache'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apis/{apiId}/ApiCaches/update'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppSync::UpdateApiCacheResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AppSync::UpdateApiCache - Arguments for method UpdateApiCache on L<Paws::AppSync> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateApiCache on the | ||
| 26 | L<AWS AppSync|Paws::AppSync> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateApiCache. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateApiCache. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $appsync = Paws->service('AppSync'); | ||
| 34 | my $UpdateApiCacheResponse = $appsync->UpdateApiCache( | ||
| 35 | ApiCachingBehavior => 'FULL_REQUEST_CACHING', | ||
| 36 | ApiId => 'MyString', | ||
| 37 | Ttl => 1, | ||
| 38 | Type => 'T2_SMALL', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $ApiCache = $UpdateApiCacheResponse->ApiCache; | ||
| 44 | |||
| 45 | # Returns a L<Paws::AppSync::UpdateApiCacheResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appsync/UpdateApiCache> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ApiCachingBehavior => Str | ||
| 54 | |||
| 55 | Caching behavior. | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | B<FULL_REQUEST_CACHING>: All requests are fully cached. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | B<PER_RESOLVER_CACHING>: Individual resolvers that you specify are | ||
| 66 | cached. | ||
| 67 | |||
| 68 | =back | ||
| 69 | |||
| 70 | |||
| 71 | Valid values are: C<"FULL_REQUEST_CACHING">, C<"PER_RESOLVER_CACHING"> | ||
| 72 | |||
| 73 | =head2 B<REQUIRED> ApiId => Str | ||
| 74 | |||
| 75 | The GraphQL API Id. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> Ttl => Int | ||
| 80 | |||
| 81 | TTL in seconds for cache entries. | ||
| 82 | |||
| 83 | Valid values are between 1 and 3600 seconds. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Type => Str | ||
| 88 | |||
| 89 | The cache instance type. Valid values are | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<SMALL> | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<MEDIUM> | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<LARGE> | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<XLARGE> | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<LARGE_2X> | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<LARGE_4X> | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<LARGE_8X> (not available in all regions) | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<LARGE_12X> | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | Historically, instance types were identified by an EC2-style value. As | ||
| 128 | of July 2020, this is deprecated, and the generic identifiers above | ||
| 129 | should be used. | ||
| 130 | |||
| 131 | The following legacy instance types are available, but their use is | ||
| 132 | discouraged: | ||
| 133 | |||
| 134 | =over | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | B<T2_SMALL>: A t2.small instance type. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | B<T2_MEDIUM>: A t2.medium instance type. | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | B<R4_LARGE>: A r4.large instance type. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | B<R4_XLARGE>: A r4.xlarge instance type. | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | B<R4_2XLARGE>: A r4.2xlarge instance type. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | B<R4_4XLARGE>: A r4.4xlarge instance type. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | B<R4_8XLARGE>: A r4.8xlarge instance type. | ||
| 163 | |||
| 164 | =back | ||
| 165 | |||
| 166 | |||
| 167 | Valid values are: C<"T2_SMALL">, C<"T2_MEDIUM">, C<"R4_LARGE">, C<"R4_XLARGE">, C<"R4_2XLARGE">, C<"R4_4XLARGE">, C<"R4_8XLARGE">, C<"SMALL">, C<"MEDIUM">, C<"LARGE">, C<"XLARGE">, C<"LARGE_2X">, C<"LARGE_4X">, C<"LARGE_8X">, C<"LARGE_12X"> | ||
| 168 | |||
| 169 | |||
| 170 | =head1 SEE ALSO | ||
| 171 | |||
| 172 | This class forms part of L<Paws>, documenting arguments for method UpdateApiCache in L<Paws::AppSync> | ||
| 173 | |||
| 174 | =head1 BUGS and CONTRIBUTIONS | ||
| 175 | |||
| 176 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 177 | |||
| 178 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 179 | |||
| 180 | =cut | ||
| 181 |