Experimental
@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
GeofenceCollection L2 construct
A Geofence Collection.
Example
declare const key: kms.Key;
new location.GeofenceCollection(this, 'GeofenceCollection', {
geofenceCollectionName: 'MyGeofenceCollection', // optional, defaults to a generated name
kmsKey: key, // optional, defaults to use an AWS managed key
});
# key: kms.Key
location.GeofenceCollection(self, "GeofenceCollection",
geofence_collection_name="MyGeofenceCollection", # optional, defaults to a generated name
kms_key=key
)
Key key;
GeofenceCollection.Builder.create(this, "GeofenceCollection")
.geofenceCollectionName("MyGeofenceCollection") // optional, defaults to a generated name
.kmsKey(key)
.build();
// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
Key key;
new GeofenceCollection(this, "GeofenceCollection", new GeofenceCollectionProps {
GeofenceCollectionName = "MyGeofenceCollection", // optional, defaults to a generated name
KmsKey = key
});
// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
var key Key
location.NewGeofenceCollection(this, jsii.String("GeofenceCollection"), &GeofenceCollectionProps{
GeofenceCollectionName: jsii.String("MyGeofenceCollection"),
// optional, defaults to a generated name
KmsKey: key,
})
Initializer
new GeofenceCollection(scope: Construct, id: string, props?: GeofenceCollectionProps)
GeofenceCollection(scope: Construct, id: str, props: typing.Optional[GeofenceCollectionProps] = None)
new GeofenceCollection(Construct scope, String id, GeofenceCollectionProps props)
new GeofenceCollection(Construct scope, string id, GeofenceCollectionProps? props = null)
NewGeofenceCollection(Scope Construct, Id *string, Props GeofenceCollectionProps)
Construct Props
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#geofenceCollectionNamestringgeofence_collection_namestrgeofenceCollectionNameStringGeofenceCollectionNamestringGeofenceCollectionName*string= A name is automatically generate…#Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.
default
Default: A name is automatically generated
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
geofenceCollectionArnstringgeofence_collection_arnstrgeofenceCollectionArnStringGeofenceCollectionArnstringGeofenceCollectionArn*stringrequired#geofenceCollectionCreateTimestringgeofence_collection_create_timestrgeofenceCollectionCreateTimeStringGeofenceCollectionCreateTimestringGeofenceCollectionCreateTime*stringrequired#geofenceCollectionNamestringgeofence_collection_namestrgeofenceCollectionNameStringGeofenceCollectionNamestringGeofenceCollectionName*stringrequired#geofenceCollectionUpdateTimestringgeofence_collection_update_timestrgeofenceCollectionUpdateTimeStringGeofenceCollectionUpdateTimestringGeofenceCollectionUpdateTime*stringrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromGeofenceCollectionArn(scope: Construct, id: string, geofenceCollectionArn: string): IGeofenceCollection@staticmethod def from_geofence_collection_arn(scope: Construct, id: str, geofence_collection_arn: str) -> IGeofenceCollectionpublic static IGeofenceCollection fromGeofenceCollectionArn(Construct scope, String id, String geofenceCollectionArn)public static IGeofenceCollection FromGeofenceCollectionArn(Construct scope, string id, string geofenceCollectionArn)func FromGeofenceCollectionArn(Scope Construct, Id *string, GeofenceCollectionArn *string) IGeofenceCollectionstatic#fromGeofenceCollectionName(scope: Construct, id: string, geofenceCollectionName: string): IGeofenceCollection@staticmethod def from_geofence_collection_name(scope: Construct, id: str, geofence_collection_name: str) -> IGeofenceCollectionpublic static IGeofenceCollection fromGeofenceCollectionName(Construct scope, String id, String geofenceCollectionName)public static IGeofenceCollection FromGeofenceCollectionName(Construct scope, string id, string geofenceCollectionName)func FromGeofenceCollectionName(Scope Construct, Id *string, GeofenceCollectionName *string) IGeofenceCollectionstatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#[disable-awslint:no-grants]
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.