AWS v6.54.0, Sep 27 24

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.apigateway.BasePathMapping

Explore with Pulumi AI

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

Create BasePathMapping Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

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

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

@overload
def BasePathMapping(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_name: Optional[str] = None,
                    rest_api: Optional[str] = None,
                    base_path: Optional[str] = None,
                    stage_name: Optional[str] = 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:apigateway:BasePathMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var basePathMappingResource = new Aws.ApiGateway.BasePathMapping("basePathMappingResource", new()
{
    DomainName = "string",
    RestApi = "string",
    BasePath = "string",
    StageName = "string",
});

example, err := apigateway.NewBasePathMapping(ctx, "basePathMappingResource", &apigateway.BasePathMappingArgs{
	DomainName: pulumi.String("string"),
	RestApi:    pulumi.Any("string"),
	BasePath:   pulumi.String("string"),
	StageName:  pulumi.String("string"),
})

var basePathMappingResource = new BasePathMapping("basePathMappingResource", BasePathMappingArgs.builder()
    .domainName("string")
    .restApi("string")
    .basePath("string")
    .stageName("string")
    .build());

base_path_mapping_resource = aws.apigateway.BasePathMapping("basePathMappingResource",
    domain_name="string",
    rest_api="string",
    base_path="string",
    stage_name="string")

const basePathMappingResource = new aws.apigateway.BasePathMapping("basePathMappingResource", {
    domainName: "string",
    restApi: "string",
    basePath: "string",
    stageName: "string",
});

type: aws:apigateway:BasePathMapping
properties:
    basePath: string
    domainName: string
    restApi: string
    stageName: string

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: Already-registered domain name to connect the API to.
RestApi string | string: ID of the API to connect.
BasePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
StageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

DomainName string: Already-registered domain name to connect the API to.
RestApi string | string: ID of the API to connect.
BasePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
StageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

domainName String: Already-registered domain name to connect the API to.
restApi String | String: ID of the API to connect.
basePath String: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
stageName String: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

domainName string: Already-registered domain name to connect the API to.
restApi string | RestApi: ID of the API to connect.
basePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
stageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

domain_name str: Already-registered domain name to connect the API to.
rest_api str | str: ID of the API to connect.
base_path str: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
stage_name str: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

domainName String: Already-registered domain name to connect the API to.
restApi String |: ID of the API to connect.
basePath String: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
stageName String: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

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.

Look up Existing BasePathMapping Resource

Get an existing BasePathMapping resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BasePathMappingState, opts?: CustomResourceOptions): BasePathMapping

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        base_path: Optional[str] = None,
        domain_name: Optional[str] = None,
        rest_api: Optional[str] = None,
        stage_name: Optional[str] = None) -> BasePathMapping

func GetBasePathMapping(ctx *Context, name string, id IDInput, state *BasePathMappingState, opts ...ResourceOption) (*BasePathMapping, error)

public static BasePathMapping Get(string name, Input<string> id, BasePathMappingState? state, CustomResourceOptions? opts = null)

public static BasePathMapping get(String name, Output<String> id, BasePathMappingState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BasePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
DomainName string: Already-registered domain name to connect the API to.
RestApi string | string: ID of the API to connect.
StageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

BasePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
DomainName string: Already-registered domain name to connect the API to.
RestApi string | string: ID of the API to connect.
StageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

basePath String: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
domainName String: Already-registered domain name to connect the API to.
restApi String | String: ID of the API to connect.
stageName String: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

basePath string: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
domainName string: Already-registered domain name to connect the API to.
restApi string | RestApi: ID of the API to connect.
stageName string: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

base_path str: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
domain_name str: Already-registered domain name to connect the API to.
rest_api str | str: ID of the API to connect.
stage_name str: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

basePath String: Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
domainName String: Already-registered domain name to connect the API to.
restApi String |: ID of the API to connect.
stageName String: Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

Import

For a non-root base_path:

Using pulumi import, import aws_api_gateway_base_path_mapping using the domain name and base path. For example:

For an empty base_path or, in other words, a root path (/):

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/

For a non-root base_path:

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/base-path

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-aws

aws.apigateway.BasePathMapping

On this page

On this page

Create BasePathMapping Resource

Constructor syntax

Parameters

Constructor example

BasePathMapping Resource Properties

Inputs

Outputs

Look up Existing BasePathMapping Resource

Import

Package Details

On this page

On this page