Package software.amazon.awscdk.services.location.alpha

Interface IPlaceIndex.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IPlaceIndex, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IPlaceIndex.Jsii$Proxy
Enclosing interface:
IPlaceIndex
@Internal public static interface IPlaceIndex.Jsii$Default extends IPlaceIndex, IResource.Jsii$Default
Internal default implementation for IPlaceIndex.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.IPlaceIndex

    IPlaceIndex.Jsii$Default, IPlaceIndex.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    default String
    getPlaceIndexArn()
    (experimental) The Amazon Resource Name (ARN) of the place index resource.
    default String
    getPlaceIndexName()
    (experimental) The name of the place index.
    default Stack
    getStack()
    The stack in which this resource is defined.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getPlaceIndexArn

      @Stability(Experimental) @NotNull default String getPlaceIndexArn()
      (experimental) The Amazon Resource Name (ARN) of the place index resource.
      Specified by:
      getPlaceIndexArn in interface IPlaceIndex

    • getPlaceIndexName

      @Stability(Experimental) @NotNull default String getPlaceIndexName()
      (experimental) The name of the place index.
      Specified by:
      getPlaceIndexName in interface IPlaceIndex

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

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

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.