1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. Api

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.apigatewayv2.Api

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    Resource Type definition for AWS::ApiGatewayV2::Api

    Create Api Resource

    new Api(name: string, args?: ApiArgs, opts?: CustomResourceOptions);
    @overload
    def Api(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_key_selection_expression: Optional[str] = None,
            base_path: Optional[str] = None,
            body: Optional[Any] = None,
            body_s3_location: Optional[ApiBodyS3LocationArgs] = None,
            cors_configuration: Optional[ApiCorsArgs] = None,
            credentials_arn: Optional[str] = None,
            description: Optional[str] = None,
            disable_execute_api_endpoint: Optional[bool] = None,
            disable_schema_validation: Optional[bool] = None,
            fail_on_warnings: Optional[bool] = None,
            name: Optional[str] = None,
            protocol_type: Optional[str] = None,
            route_key: Optional[str] = None,
            route_selection_expression: Optional[str] = None,
            tags: Optional[Any] = None,
            target: Optional[str] = None,
            version: Optional[str] = None)
    @overload
    def Api(resource_name: str,
            args: Optional[ApiArgs] = None,
            opts: Optional[ResourceOptions] = None)
    func NewApi(ctx *Context, name string, args *ApiArgs, opts ...ResourceOption) (*Api, error)
    public Api(string name, ApiArgs? args = null, CustomResourceOptions? opts = null)
    public Api(String name, ApiArgs args)
    public Api(String name, ApiArgs args, CustomResourceOptions options)
    
    type: aws-native:apigatewayv2:Api
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Api Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Api resource accepts the following input properties:

    ApiKeySelectionExpression string
    BasePath string
    Body interface{}
    BodyS3Location ApiBodyS3LocationArgs
    CorsConfiguration ApiCorsArgs
    CredentialsArn string
    Description string
    DisableExecuteApiEndpoint bool
    DisableSchemaValidation bool
    FailOnWarnings bool
    Name string
    ProtocolType string
    RouteKey string
    RouteSelectionExpression string
    Tags interface{}

    This resource type use map for Tags, suggest to use List of Tag

    Target string
    Version string
    apiKeySelectionExpression String
    basePath String
    body Object
    bodyS3Location ApiBodyS3Location
    corsConfiguration ApiCors
    credentialsArn String
    description String
    disableExecuteApiEndpoint Boolean
    disableSchemaValidation Boolean
    failOnWarnings Boolean
    name String
    protocolType String
    routeKey String
    routeSelectionExpression String
    tags Object

    This resource type use map for Tags, suggest to use List of Tag

    target String
    version String
    apiKeySelectionExpression string
    basePath string
    body any
    bodyS3Location ApiBodyS3Location
    corsConfiguration ApiCors
    credentialsArn string
    description string
    disableExecuteApiEndpoint boolean
    disableSchemaValidation boolean
    failOnWarnings boolean
    name string
    protocolType string
    routeKey string
    routeSelectionExpression string
    tags any

    This resource type use map for Tags, suggest to use List of Tag

    target string
    version string
    apiKeySelectionExpression String
    basePath String
    body Any
    bodyS3Location Property Map
    corsConfiguration Property Map
    credentialsArn String
    description String
    disableExecuteApiEndpoint Boolean
    disableSchemaValidation Boolean
    failOnWarnings Boolean
    name String
    protocolType String
    routeKey String
    routeSelectionExpression String
    tags Any

    This resource type use map for Tags, suggest to use List of Tag

    target String
    version String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:

    ApiEndpoint string
    ApiId string
    Id string

    The provider-assigned unique ID for this managed resource.

    ApiEndpoint string
    ApiId string
    Id string

    The provider-assigned unique ID for this managed resource.

    apiEndpoint String
    apiId String
    id String

    The provider-assigned unique ID for this managed resource.

    apiEndpoint string
    apiId string
    id string

    The provider-assigned unique ID for this managed resource.

    api_endpoint str
    api_id str
    id str

    The provider-assigned unique ID for this managed resource.

    apiEndpoint String
    apiId String
    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ApiBodyS3Location, ApiBodyS3LocationArgs

    Bucket string
    Etag string
    Key string
    Version string
    Bucket string
    Etag string
    Key string
    Version string
    bucket String
    etag String
    key String
    version String
    bucket string
    etag string
    key string
    version string
    bucket str
    etag str
    key str
    version str
    bucket String
    etag String
    key String
    version String

    ApiCors, ApiCorsArgs

    AllowCredentials bool
    AllowHeaders List<string>
    AllowMethods List<string>
    AllowOrigins List<string>
    ExposeHeaders List<string>
    MaxAge int
    allowCredentials Boolean
    allowHeaders List<String>
    allowMethods List<String>
    allowOrigins List<String>
    exposeHeaders List<String>
    maxAge Integer
    allowCredentials boolean
    allowHeaders string[]
    allowMethods string[]
    allowOrigins string[]
    exposeHeaders string[]
    maxAge number
    allow_credentials bool
    allow_headers Sequence[str]
    allow_methods Sequence[str]
    allow_origins Sequence[str]
    expose_headers Sequence[str]
    max_age int
    allowCredentials Boolean
    allowHeaders List<String>
    allowMethods List<String>
    allowOrigins List<String>
    exposeHeaders List<String>
    maxAge Number

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi