Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. location
  5. GeofenceCollection
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.location.GeofenceCollection

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Location Geofence Collection.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.location.GeofenceCollection("example", {collectionName: "example"});

    import pulumi
import pulumi_aws as aws

example = aws.location.GeofenceCollection("example", collection_name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/location"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := location.NewGeofenceCollection(ctx, "example", &location.GeofenceCollectionArgs{
			CollectionName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Location.GeofenceCollection("example", new()
    {
        CollectionName = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.GeofenceCollection;
import com.pulumi.aws.location.GeofenceCollectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new GeofenceCollection("example", GeofenceCollectionArgs.builder()
            .collectionName("example")
            .build());

    }
}

    resources:
  example:
    type: aws:location:GeofenceCollection
    properties:
      collectionName: example

    Create GeofenceCollection Resource

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

    Constructor syntax

    new GeofenceCollection(name: string, args: GeofenceCollectionArgs, opts?: CustomResourceOptions);
    @overload
def GeofenceCollection(resource_name: str,
                       args: GeofenceCollectionArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def GeofenceCollection(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       collection_name: Optional[str] = None,
                       description: Optional[str] = None,
                       kms_key_id: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewGeofenceCollection(ctx *Context, name string, args GeofenceCollectionArgs, opts ...ResourceOption) (*GeofenceCollection, error)
    public GeofenceCollection(string name, GeofenceCollectionArgs args, CustomResourceOptions? opts = null)
    public GeofenceCollection(String name, GeofenceCollectionArgs args)
public GeofenceCollection(String name, GeofenceCollectionArgs args, CustomResourceOptions options)

    type: aws:location:GeofenceCollection
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 GeofenceCollectionArgs
    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 GeofenceCollectionArgs
    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 GeofenceCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GeofenceCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GeofenceCollectionArgs
    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 geofenceCollectionResource = new Aws.Location.GeofenceCollection("geofenceCollectionResource", new()
{
    CollectionName = "string",
    Description = "string",
    KmsKeyId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := location.NewGeofenceCollection(ctx, "geofenceCollectionResource", &location.GeofenceCollectionArgs{
	CollectionName: pulumi.String("string"),
	Description:    pulumi.String("string"),
	KmsKeyId:       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var geofenceCollectionResource = new GeofenceCollection("geofenceCollectionResource", GeofenceCollectionArgs.builder()
    .collectionName("string")
    .description("string")
    .kmsKeyId("string")
    .tags(Map.of("string", "string"))
    .build());

    geofence_collection_resource = aws.location.GeofenceCollection("geofenceCollectionResource",
    collection_name="string",
    description="string",
    kms_key_id="string",
    tags={
        "string": "string",
    })

    const geofenceCollectionResource = new aws.location.GeofenceCollection("geofenceCollectionResource", {
    collectionName: "string",
    description: "string",
    kmsKeyId: "string",
    tags: {
        string: "string",
    },
});

    type: aws:location:GeofenceCollection
properties:
    collectionName: string
    description: string
    kmsKeyId: string
    tags:
        string: string

    GeofenceCollection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GeofenceCollection resource accepts the following input properties:

    CollectionName string

    The name of the geofence collection.

    The following arguments are optional:

    Description string
    The optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    Tags Dictionary<string, string>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CollectionName string

    The name of the geofence collection.

    The following arguments are optional:

    Description string
    The optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    Tags map[string]string
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    collectionName String

    The name of the geofence collection.

    The following arguments are optional:

    description String
    The optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Map<String,String>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    collectionName string

    The name of the geofence collection.

    The following arguments are optional:

    description string
    The optional description for the geofence collection.
    kmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags {[key: string]: string}
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    collection_name str

    The name of the geofence collection.

    The following arguments are optional:

    description str
    The optional description for the geofence collection.
    kms_key_id str
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Mapping[str, str]
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    collectionName String

    The name of the geofence collection.

    The following arguments are optional:

    description String
    The optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Map<String>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    CollectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    CollectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn String
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    createTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collection_arn str
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    create_time str
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn String
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.

    Look up Existing GeofenceCollection Resource

    Get an existing GeofenceCollection 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?: GeofenceCollectionState, opts?: CustomResourceOptions): GeofenceCollection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collection_arn: Optional[str] = None,
        collection_name: Optional[str] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        update_time: Optional[str] = None) -> GeofenceCollection
    func GetGeofenceCollection(ctx *Context, name string, id IDInput, state *GeofenceCollectionState, opts ...ResourceOption) (*GeofenceCollection, error)
    public static GeofenceCollection Get(string name, Input<string> id, GeofenceCollectionState? state, CustomResourceOptions? opts = null)
    public static GeofenceCollection get(String name, Output<String> id, GeofenceCollectionState 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:
    CollectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    CollectionName string

    The name of the geofence collection.

    The following arguments are optional:

    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    Description string
    The optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    Tags Dictionary<string, string>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    CollectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    CollectionName string

    The name of the geofence collection.

    The following arguments are optional:

    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    Description string
    The optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    Tags map[string]string
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn String
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    collectionName String

    The name of the geofence collection.

    The following arguments are optional:

    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    description String
    The optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Map<String,String>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn string
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    collectionName string

    The name of the geofence collection.

    The following arguments are optional:

    createTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    description string
    The optional description for the geofence collection.
    kmsKeyId string
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags {[key: string]: string}
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collection_arn str
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    collection_name str

    The name of the geofence collection.

    The following arguments are optional:

    create_time str
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    description str
    The optional description for the geofence collection.
    kms_key_id str
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Mapping[str, str]
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
    collectionArn String
    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
    collectionName String

    The name of the geofence collection.

    The following arguments are optional:

    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format.
    description String
    The optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
    tags Map<String>
    Key-value tags for the geofence collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format.

    Import

    Using pulumi import, import Location Geofence Collection using the collection_name. For example:

    $ pulumi import aws:location/geofenceCollection:GeofenceCollection example example

    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 logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws