« blib/lib/Paws/AppSync/UpdateFunctionResponse.pm
↑ Summary
blib/lib/Paws/AppSync/UpdateGraphqlApiResponse.pm »
| 1 | |||
| 2 | package Paws::AppSync::UpdateGraphqlApi; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalAuthenticationProviders => (is => 'ro', isa => 'ArrayRef[Paws::AppSync::AdditionalAuthenticationProvider]', traits => ['NameInRequest'], request_name => 'additionalAuthenticationProviders'); | ||
| 5 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 6 | has AuthenticationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authenticationType'); | ||
| 7 | has LogConfig => (is => 'ro', isa => 'Paws::AppSync::LogConfig', traits => ['NameInRequest'], request_name => 'logConfig'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 9 | has OpenIDConnectConfig => (is => 'ro', isa => 'Paws::AppSync::OpenIDConnectConfig', traits => ['NameInRequest'], request_name => 'openIDConnectConfig'); | ||
| 10 | has UserPoolConfig => (is => 'ro', isa => 'Paws::AppSync::UserPoolConfig', traits => ['NameInRequest'], request_name => 'userPoolConfig'); | ||
| 11 | has XrayEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'xrayEnabled'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateGraphqlApi'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apis/{apiId}'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppSync::UpdateGraphqlApiResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::AppSync::UpdateGraphqlApi - Arguments for method UpdateGraphqlApi on L<Paws::AppSync> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method UpdateGraphqlApi on the | ||
| 30 | L<AWS AppSync|Paws::AppSync> service. Use the attributes of this class | ||
| 31 | as arguments to method UpdateGraphqlApi. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateGraphqlApi. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $appsync = Paws->service('AppSync'); | ||
| 38 | my $UpdateGraphqlApiResponse = $appsync->UpdateGraphqlApi( | ||
| 39 | ApiId => 'MyString', | ||
| 40 | Name => 'MyString', | ||
| 41 | AdditionalAuthenticationProviders => [ | ||
| 42 | { | ||
| 43 | AuthenticationType => 'API_KEY' | ||
| 44 | , # values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT; OPTIONAL | ||
| 45 | OpenIDConnectConfig => { | ||
| 46 | Issuer => 'MyString', | ||
| 47 | AuthTTL => 1, # OPTIONAL | ||
| 48 | ClientId => 'MyString', | ||
| 49 | IatTTL => 1, # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | UserPoolConfig => { | ||
| 52 | AwsRegion => 'MyString', | ||
| 53 | UserPoolId => 'MyString', | ||
| 54 | AppIdClientRegex => 'MyString', | ||
| 55 | }, # OPTIONAL | ||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # OPTIONAL | ||
| 59 | AuthenticationType => 'API_KEY', # OPTIONAL | ||
| 60 | LogConfig => { | ||
| 61 | CloudWatchLogsRoleArn => 'MyString', | ||
| 62 | FieldLogLevel => 'NONE', # values: NONE, ERROR, ALL | ||
| 63 | ExcludeVerboseContent => 1, # OPTIONAL | ||
| 64 | }, # OPTIONAL | ||
| 65 | OpenIDConnectConfig => { | ||
| 66 | Issuer => 'MyString', | ||
| 67 | AuthTTL => 1, # OPTIONAL | ||
| 68 | ClientId => 'MyString', | ||
| 69 | IatTTL => 1, # OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | UserPoolConfig => { | ||
| 72 | AwsRegion => 'MyString', | ||
| 73 | DefaultAction => 'ALLOW', # values: ALLOW, DENY | ||
| 74 | UserPoolId => 'MyString', | ||
| 75 | AppIdClientRegex => 'MyString', | ||
| 76 | }, # OPTIONAL | ||
| 77 | XrayEnabled => 1, # OPTIONAL | ||
| 78 | ); | ||
| 79 | |||
| 80 | # Results: | ||
| 81 | my $GraphqlApi = $UpdateGraphqlApiResponse->GraphqlApi; | ||
| 82 | |||
| 83 | # Returns a L<Paws::AppSync::UpdateGraphqlApiResponse> object. | ||
| 84 | |||
| 85 | 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. | ||
| 86 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appsync/UpdateGraphqlApi> | ||
| 87 | |||
| 88 | =head1 ATTRIBUTES | ||
| 89 | |||
| 90 | |||
| 91 | =head2 AdditionalAuthenticationProviders => ArrayRef[L<Paws::AppSync::AdditionalAuthenticationProvider>] | ||
| 92 | |||
| 93 | A list of additional authentication providers for the C<GraphqlApi> | ||
| 94 | API. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> ApiId => Str | ||
| 99 | |||
| 100 | The API ID. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 AuthenticationType => Str | ||
| 105 | |||
| 106 | The new authentication type for the C<GraphqlApi> object. | ||
| 107 | |||
| 108 | Valid values are: C<"API_KEY">, C<"AWS_IAM">, C<"AMAZON_COGNITO_USER_POOLS">, C<"OPENID_CONNECT"> | ||
| 109 | |||
| 110 | =head2 LogConfig => L<Paws::AppSync::LogConfig> | ||
| 111 | |||
| 112 | The Amazon CloudWatch Logs configuration for the C<GraphqlApi> object. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Name => Str | ||
| 117 | |||
| 118 | The new name for the C<GraphqlApi> object. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 OpenIDConnectConfig => L<Paws::AppSync::OpenIDConnectConfig> | ||
| 123 | |||
| 124 | The OpenID Connect configuration for the C<GraphqlApi> object. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 UserPoolConfig => L<Paws::AppSync::UserPoolConfig> | ||
| 129 | |||
| 130 | The new Amazon Cognito user pool configuration for the C<GraphqlApi> | ||
| 131 | object. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 XrayEnabled => Bool | ||
| 136 | |||
| 137 | A flag indicating whether to enable X-Ray tracing for the | ||
| 138 | C<GraphqlApi>. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method UpdateGraphqlApi in L<Paws::AppSync> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |