NAME

Paws::ApiGatewayV2::UpdateApi - Arguments for method UpdateApi on Paws::ApiGatewayV2

DESCRIPTION

This class represents the parameters used for calling the method UpdateApi on the AmazonApiGatewayV2 service. Use the attributes of this class as arguments to method UpdateApi.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateApi.

SYNOPSIS

    my $apigateway = Paws->service('ApiGatewayV2');
    my $UpdateApiResponse = $apigateway->UpdateApi(
      ApiId                     => 'My__string',
      ApiKeySelectionExpression => 'MySelectionExpression',    # OPTIONAL
      CorsConfiguration         => {
        AllowCredentials => 1,                                 # OPTIONAL
        AllowHeaders     => [ 'My__string', ... ],             # OPTIONAL
        AllowMethods  => [ 'MyStringWithLengthBetween1And64', ... ],  # OPTIONAL
        AllowOrigins  => [ 'My__string', ... ],                       # OPTIONAL
        ExposeHeaders => [ 'My__string', ... ],                       # OPTIONAL
        MaxAge => 1,    # min: -1, max: 86400; OPTIONAL
      },    # OPTIONAL
      CredentialsArn          => 'MyArn',                             # OPTIONAL
      Description             => 'MyStringWithLengthBetween0And1024', # OPTIONAL
      DisableSchemaValidation => 1,                                   # OPTIONAL
      Name                    => 'MyStringWithLengthBetween1And128',  # OPTIONAL
      RouteKey                => 'MySelectionKey',                    # OPTIONAL
      RouteSelectionExpression => 'MySelectionExpression',            # OPTIONAL
      Target                   => 'MyUriWithLengthBetween1And2048',   # OPTIONAL
      Version                  => 'MyStringWithLengthBetween1And64',  # OPTIONAL
    );

    # Results:
    my $ApiEndpoint = $UpdateApiResponse->ApiEndpoint;
    my $ApiId       = $UpdateApiResponse->ApiId;
    my $ApiKeySelectionExpression =
      $UpdateApiResponse->ApiKeySelectionExpression;
    my $CorsConfiguration        = $UpdateApiResponse->CorsConfiguration;
    my $CreatedDate              = $UpdateApiResponse->CreatedDate;
    my $Description              = $UpdateApiResponse->Description;
    my $DisableSchemaValidation  = $UpdateApiResponse->DisableSchemaValidation;
    my $ImportInfo               = $UpdateApiResponse->ImportInfo;
    my $Name                     = $UpdateApiResponse->Name;
    my $ProtocolType             = $UpdateApiResponse->ProtocolType;
    my $RouteSelectionExpression = $UpdateApiResponse->RouteSelectionExpression;
    my $Tags                     = $UpdateApiResponse->Tags;
    my $Version                  = $UpdateApiResponse->Version;
    my $Warnings                 = $UpdateApiResponse->Warnings;

    # Returns a L<Paws::ApiGatewayV2::UpdateApiResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateApi

ATTRIBUTES

REQUIRED ApiId => Str

The API identifier.

ApiKeySelectionExpression => Str

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).

CorsConfiguration => Paws::ApiGatewayV2::Cors

A CORS configuration. Supported only for HTTP APIs.

CredentialsArn => Str

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Description => Str

The description of the API.

DisableSchemaValidation => Bool

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Name => Str

The name of the API.

RouteKey => Str

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

RouteSelectionExpression => Str

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Target => Str

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Version => Str

A version identifier for the API.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateApi in Paws::ApiGatewayV2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config