Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getGeofenceCollection

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.getGeofenceCollection

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::GeofenceCollection Resource Type

    Using getGeofenceCollection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGeofenceCollection(args: GetGeofenceCollectionArgs, opts?: InvokeOptions): Promise<GetGeofenceCollectionResult>
function getGeofenceCollectionOutput(args: GetGeofenceCollectionOutputArgs, opts?: InvokeOptions): Output<GetGeofenceCollectionResult>
    def get_geofence_collection(collection_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGeofenceCollectionResult
def get_geofence_collection_output(collection_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGeofenceCollectionResult]
    func LookupGeofenceCollection(ctx *Context, args *LookupGeofenceCollectionArgs, opts ...InvokeOption) (*LookupGeofenceCollectionResult, error)
func LookupGeofenceCollectionOutput(ctx *Context, args *LookupGeofenceCollectionOutputArgs, opts ...InvokeOption) LookupGeofenceCollectionResultOutput

    > Note: This function is named LookupGeofenceCollection in the Go SDK.

    public static class GetGeofenceCollection 
{
    public static Task<GetGeofenceCollectionResult> InvokeAsync(GetGeofenceCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetGeofenceCollectionResult> Invoke(GetGeofenceCollectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGeofenceCollectionResult> getGeofenceCollection(GetGeofenceCollectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:location:getGeofenceCollection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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 .
    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 .
    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 .
    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 .
    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 .
    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 .

    getGeofenceCollection Result

    The following output properties are available:

    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 .
    Description string
    An optional description for the geofence collection.
    PricingPlan Pulumi.AwsNative.Location.GeofenceCollectionPricingPlan
    PricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this 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 .
    Description string
    An optional description for the geofence collection.
    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.
    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 .
    description String
    An optional description for the geofence collection.
    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.
    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 .
    description string
    An optional description for the geofence collection.
    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.
    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 .
    description str
    An optional description for the geofence collection.
    pricing_plan GeofenceCollectionPricingPlan
    pricing_plan_data_source str
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this 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 .
    description String
    An optional description for the geofence collection.
    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.
    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

    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 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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native