« blib/lib/Paws/ApiGatewayV2/Models.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/MutualTlsAuthenticationInput.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::MutualTlsAuthentication; | ||
| 3 | use Moose; | ||
| 4 | has TruststoreUri => (is => 'ro', isa => 'Str', request_name => 'truststoreUri', traits => ['NameInRequest']); | ||
| 5 | has TruststoreVersion => (is => 'ro', isa => 'Str', request_name => 'truststoreVersion', traits => ['NameInRequest']); | ||
| 6 | has TruststoreWarnings => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'truststoreWarnings', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ApiGatewayV2::MutualTlsAuthentication | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::MutualTlsAuthentication object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { TruststoreUri => $value, ..., TruststoreWarnings => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::MutualTlsAuthentication object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->TruststoreUri | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This class has no description | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 TruststoreUri => Str | ||
| 44 | |||
| 45 | An Amazon S3 URL that specifies the truststore for mutual TLS | ||
| 46 | authentication, for example, s3://bucket-name/key-name. The truststore | ||
| 47 | can contain certificates from public or private certificate | ||
| 48 | authorities. To update the truststore, upload a new version to S3, and | ||
| 49 | then update your custom domain name to use the new version. To update | ||
| 50 | the truststore, you must have permissions to access the S3 object. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 TruststoreVersion => Str | ||
| 54 | |||
| 55 | The version of the S3 object that contains your truststore. To specify | ||
| 56 | a version, you must have versioning enabled for the S3 bucket. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 TruststoreWarnings => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | A list of warnings that API Gateway returns while processing your | ||
| 62 | truststore. Invalid certificates produce warnings. Mutual TLS is still | ||
| 63 | enabled, but some clients might not be able to access your API. To | ||
| 64 | resolve warnings, upload a new truststore to S3, and then update you | ||
| 65 | domain name to use the new version. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |