@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)
71 lines (70 loc) • 3.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Location::GeofenceCollection Resource Type
*/
export declare function getGeofenceCollection(args: GetGeofenceCollectionArgs, opts?: pulumi.InvokeOptions): Promise<GetGeofenceCollectionResult>;
export interface GetGeofenceCollectionArgs {
/**
* A custom name for the geofence collection.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique geofence collection name.
* - No spaces allowed. For example, `ExampleGeofenceCollection` .
*/
collectionName: string;
}
export interface GetGeofenceCollectionResult {
/**
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
*/
readonly arn?: string;
/**
* Synonym for `Arn` . The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
*/
readonly collectionArn?: string;
/**
* The timestamp for when the geofence collection 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?: string;
/**
* An optional description for the geofence collection.
*/
readonly description?: string;
readonly pricingPlan?: enums.location.GeofenceCollectionPricingPlan;
/**
* This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
*/
readonly pricingPlanDataSource?: string;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags?: outputs.Tag[];
/**
* The timestamp for when the geofence collection 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?: string;
}
/**
* Definition of AWS::Location::GeofenceCollection Resource Type
*/
export declare function getGeofenceCollectionOutput(args: GetGeofenceCollectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGeofenceCollectionResult>;
export interface GetGeofenceCollectionOutputArgs {
/**
* A custom name for the geofence collection.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique geofence collection name.
* - No spaces allowed. For example, `ExampleGeofenceCollection` .
*/
collectionName: pulumi.Input<string>;
}