Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. GeofenceCollection

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.GeofenceCollection

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::GeofenceCollection Resource Type

    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: Optional[GeofenceCollectionArgs] = None,
                       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,
                       pricing_plan: Optional[GeofenceCollectionPricingPlan] = None,
                       pricing_plan_data_source: Optional[str] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewGeofenceCollection(ctx *Context, name string, args *GeofenceCollectionArgs, opts ...ResourceOption) (*GeofenceCollection, error)
    public GeofenceCollection(string name, GeofenceCollectionArgs? args = null, CustomResourceOptions? opts = null)
    public GeofenceCollection(String name, GeofenceCollectionArgs args)
public GeofenceCollection(String name, GeofenceCollectionArgs args, CustomResourceOptions options)

    type: aws-native: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.

    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

    The GeofenceCollection resource accepts the following input properties:

    CollectionName string

    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 .
    Description string
    An optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    PricingPlan Pulumi.AwsNative.Location.GeofenceCollectionPricingPlan
    PricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    CollectionName string

    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 .
    Description string
    An optional description for the geofence collection.
    KmsKeyId string
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    PricingPlan GeofenceCollectionPricingPlan
    PricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    collectionName String

    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 .
    description String
    An optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    pricingPlan GeofenceCollectionPricingPlan
    pricingPlanDataSource String
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    collectionName string

    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 .
    description string
    An optional description for the geofence collection.
    kmsKeyId string
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    pricingPlan GeofenceCollectionPricingPlan
    pricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    collection_name str

    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 .
    description str
    An optional description for the geofence collection.
    kms_key_id str
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    pricing_plan GeofenceCollectionPricingPlan
    pricing_plan_data_source str
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    collectionName String

    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 .
    description String
    An optional description for the geofence collection.
    kmsKeyId String
    A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
    pricingPlan "RequestBasedUsage"
    pricingPlanDataSource String
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

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

    Arn string
    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
    CollectionArn 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
    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    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
    CollectionArn 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
    CreateTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    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
    collectionArn 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
    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    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
    collectionArn 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
    createTime string
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    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
    collection_arn str
    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
    create_time str
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    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
    collectionArn 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
    createTime String
    The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    GeofenceCollectionPricingPlan, GeofenceCollectionPricingPlanArgs

    RequestBasedUsage
    RequestBasedUsage
    GeofenceCollectionPricingPlanRequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    REQUEST_BASED_USAGE
    RequestBasedUsage
    "RequestBasedUsage"
    RequestBasedUsage

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native