@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
172 lines (171 loc) • 6.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a Location Service Map.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.location.Map("example", {
* configuration: {
* style: "VectorHereBerlin",
* },
* mapName: "example",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_location_map` resources using the map name. For example:
*
* ```sh
* $ pulumi import aws:location/map:Map example example
* ```
*/
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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MapState, 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;
/**
* Configuration block with the map style selected from an available data provider. Detailed below.
*/
readonly configuration: pulumi.Output<outputs.location.MapConfiguration>;
/**
* The timestamp for when the map resource was created in ISO 8601 format.
*/
readonly createTime: pulumi.Output<string>;
/**
* An optional description for the map resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
*/
readonly mapArn: pulumi.Output<string>;
/**
* The name for the map resource.
*
* The following arguments are optional:
*/
readonly mapName: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value tags for the map. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The timestamp for when the map resource was last updated in ISO 8601 format.
*/
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);
}
/**
* Input properties used for looking up and filtering Map resources.
*/
export interface MapState {
/**
* Configuration block with the map style selected from an available data provider. Detailed below.
*/
configuration?: pulumi.Input<inputs.location.MapConfiguration>;
/**
* The timestamp for when the map resource was created in ISO 8601 format.
*/
createTime?: pulumi.Input<string>;
/**
* An optional description for the map resource.
*/
description?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
*/
mapArn?: pulumi.Input<string>;
/**
* The name for the map resource.
*
* The following arguments are optional:
*/
mapName?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value tags for the map. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The timestamp for when the map resource was last updated in ISO 8601 format.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Map resource.
*/
export interface MapArgs {
/**
* Configuration block with the map style selected from an available data provider. Detailed below.
*/
configuration: pulumi.Input<inputs.location.MapConfiguration>;
/**
* An optional description for the map resource.
*/
description?: pulumi.Input<string>;
/**
* The name for the map resource.
*
* The following arguments are optional:
*/
mapName: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value tags for the map. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}