AWS Native v0.55.0, Mar 28 23

aws-native.apigateway.BasePathMapping

Resource Type definition for AWS::ApiGateway::BasePathMapping

Create BasePathMapping Resource

new BasePathMapping(name: string, args: BasePathMappingArgs, opts?: CustomResourceOptions);

@overload
def BasePathMapping(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    base_path: Optional[str] = None,
                    domain_name: Optional[str] = None,
                    rest_api_id: Optional[str] = None,
                    stage: Optional[str] = None)
@overload
def BasePathMapping(resource_name: str,
                    args: BasePathMappingArgs,
                    opts: Optional[ResourceOptions] = None)

func NewBasePathMapping(ctx *Context, name string, args BasePathMappingArgs, opts ...ResourceOption) (*BasePathMapping, error)

public BasePathMapping(string name, BasePathMappingArgs args, CustomResourceOptions? opts = null)

public BasePathMapping(String name, BasePathMappingArgs args)
public BasePathMapping(String name, BasePathMappingArgs args, CustomResourceOptions options)

type: aws-native:apigateway:BasePathMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BasePathMappingArgs: 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 BasePathMappingArgs: 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 BasePathMappingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BasePathMappingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BasePathMappingArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

BasePathMapping 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 BasePathMapping resource accepts the following input properties:

DomainName string: The DomainName of an AWS::ApiGateway::DomainName resource.
BasePath string: The base path name that callers of the API must provide in the URL after the domain name.
RestApiId string: The ID of the API.
Stage string: The name of the API's stage.

DomainName string: The DomainName of an AWS::ApiGateway::DomainName resource.
BasePath string: The base path name that callers of the API must provide in the URL after the domain name.
RestApiId string: The ID of the API.
Stage string: The name of the API's stage.

domainName String: The DomainName of an AWS::ApiGateway::DomainName resource.
basePath String: The base path name that callers of the API must provide in the URL after the domain name.
restApiId String: The ID of the API.
stage String: The name of the API's stage.

domainName string: The DomainName of an AWS::ApiGateway::DomainName resource.
basePath string: The base path name that callers of the API must provide in the URL after the domain name.
restApiId string: The ID of the API.
stage string: The name of the API's stage.

domain_name str: The DomainName of an AWS::ApiGateway::DomainName resource.
base_path str: The base path name that callers of the API must provide in the URL after the domain name.
rest_api_id str: The ID of the API.
stage str: The name of the API's stage.

domainName String: The DomainName of an AWS::ApiGateway::DomainName resource.
basePath String: The base path name that callers of the API must provide in the URL after the domain name.
restApiId String: The ID of the API.
stage String: The name of the API's stage.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Package Details

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