Interface IComponent.Jsii$Default

All Superinterfaces:
IComponent, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IComponent.Jsii$Proxy
Enclosing interface:
IComponent

@Internal public static interface IComponent.Jsii$Default extends IComponent, IResource.Jsii$Default
Internal default implementation for IComponent.
  • 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 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.

      Specified by:
      getEnv in interface IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      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
    • getComponentArn

      @Stability(Experimental) @NotNull default String getComponentArn()
      (experimental) The ARN of the component.
      Specified by:
      getComponentArn in interface IComponent
    • getComponentName

      @Stability(Experimental) @NotNull default String getComponentName()
      (experimental) The name of the component.
      Specified by:
      getComponentName in interface IComponent
    • getComponentVersion

      @Stability(Experimental) @NotNull default String getComponentVersion()
      (experimental) The version of the component.
      Specified by:
      getComponentVersion in interface IComponent
    • 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.
    • grant

      @Stability(Experimental) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grant custom actions to the given grantee for the component.

      Specified by:
      grant in interface IComponent
      Parameters:
      grantee - The principal. This parameter is required.
      actions - The list of actions. This parameter is required.
    • grantRead

      @Stability(Experimental) @NotNull default Grant grantRead(@NotNull IGrantable grantee)
      (experimental) Grant read permissions to the given grantee for the component.

      Specified by:
      grantRead in interface IComponent
      Parameters:
      grantee - The principal. This parameter is required.