Class CfnGeofenceCollection
The AWS::Location::GeofenceCollection
resource specifies the ability to detect and act when a tracked device enters or exits a defined geographical boundary known as a geofence.
Inherited Members
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGeofenceCollection : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnGeofenceCollection
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
CloudformationResource: AWS::Location::GeofenceCollection
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Location;
var cfnGeofenceCollection = new CfnGeofenceCollection(this, "MyCfnGeofenceCollection", new CfnGeofenceCollectionProps {
CollectionName = "collectionName",
// the properties below are optional
Description = "description",
KmsKeyId = "kmsKeyId",
PricingPlan = "pricingPlan",
PricingPlanDataSource = "pricingPlanDataSource",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnGeofenceCollection(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGeofenceCollection(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGeofenceCollection(Construct, String, ICfnGeofenceCollectionProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) for the geofence collection resource. |
AttrCollectionArn | Synonym for |
AttrCreateTime | The timestamp for when the geofence collection resource was created in ISO 8601 format: |
AttrUpdateTime | The timestamp for when the geofence collection resource was last updated in ISO 8601 format: |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CollectionName | A custom name for the geofence collection. |
Description | An optional description for the geofence collection. |
KmsKeyId | A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN. |
PricingPlan | |
PricingPlanDataSource | |
Tags | Applies one or more tags to the geofence collection. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGeofenceCollection(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGeofenceCollection(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGeofenceCollection(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGeofenceCollection(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGeofenceCollection(Construct, String, ICfnGeofenceCollectionProps)
public CfnGeofenceCollection(Construct scope, string id, ICfnGeofenceCollectionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGeofenceCollectionProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) for the geofence collection resource.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
Used when you need to specify a resource across all AWS .
CloudformationAttribute: Arn
AttrCollectionArn
Synonym for Arn
.
public virtual string AttrCollectionArn { get; }
Property Value
System.String
Remarks
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS .
CloudformationAttribute: CollectionArn
AttrCreateTime
The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
public virtual string AttrCreateTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreateTime
AttrUpdateTime
The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
public virtual string AttrUpdateTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdateTime
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CollectionName
A custom name for the geofence collection.
public virtual string CollectionName { get; set; }
Property Value
System.String
Description
An optional description for the geofence collection.
public virtual string Description { get; set; }
Property Value
System.String
KmsKeyId
A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
PricingPlan
public virtual string PricingPlan { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
PricingPlanDataSource
public virtual string PricingPlanDataSource { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
Tags
Applies one or more tags to the geofence collection.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>