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