@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
113 lines (112 loc) • 4.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Location::Map Resource Type
*/
export declare class Map extends pulumi.CustomResource {
/**
* Get an existing Map resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Map;
/**
* Returns true if the given object is an instance of Map. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Map;
/**
* The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
*/
readonly arn: pulumi.Output<string>;
/**
* Specifies the `MapConfiguration` , including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
*/
readonly configuration: pulumi.Output<outputs.location.MapConfiguration>;
/**
* The timestamp for when the map resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly createTime: pulumi.Output<string>;
/**
* An optional description for the map resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Synonym for `Arn` . The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
*/
readonly mapArn: pulumi.Output<string>;
/**
* The name for the map resource.
*
* Requirements:
*
* - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique map resource name.
* - No spaces allowed. For example, `ExampleMap` .
*/
readonly mapName: pulumi.Output<string>;
/**
* No longer used. If included, the only allowed value is `RequestBasedUsage` .
*
* *Allowed Values* : `RequestBasedUsage`
*/
readonly pricingPlan: pulumi.Output<enums.location.MapPricingPlan | undefined>;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The timestamp for when the map resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Map resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MapArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Map resource.
*/
export interface MapArgs {
/**
* Specifies the `MapConfiguration` , including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
*/
configuration: pulumi.Input<inputs.location.MapConfigurationArgs>;
/**
* An optional description for the map resource.
*/
description?: pulumi.Input<string>;
/**
* The name for the map resource.
*
* Requirements:
*
* - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique map resource name.
* - No spaces allowed. For example, `ExampleMap` .
*/
mapName?: pulumi.Input<string>;
/**
* No longer used. If included, the only allowed value is `RequestBasedUsage` .
*
* *Allowed Values* : `RequestBasedUsage`
*/
pricingPlan?: pulumi.Input<enums.location.MapPricingPlan>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}