Package software.amazon.awscdk.services.greengrassv2

Class CfnComponent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.greengrassv2.CfnComponent
All Implemented Interfaces:
IInspectable, IComponentRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:04.569Z") @Stability(Stable) public class CfnComponent extends CfnResource implements IInspectable, IComponentRef, ITaggableV2
Represents an AWS IoT Greengrass V2 component, which is a software module deployed to Greengrass core devices.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 CfnComponent cfnComponent = CfnComponent.Builder.create(this, "MyCfnComponent")
         .componentName("componentName")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnComponent

      protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnComponent

      protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnComponent

      @Stability(Stable) public CfnComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnComponentProps props)
      Create a new AWS::GreengrassV2::Component.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnComponent

      @Stability(Stable) public CfnComponent(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::GreengrassV2::Component.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForComponent

      @Stability(Stable) @NotNull public static String arnForComponent(@NotNull IComponentRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnComponent

      @Stability(Stable) @NotNull public static Boolean isCfnComponent(@NotNull Object x)
      Checks whether the given object is a CfnComponent.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the component.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getComponentRef

      @Stability(Stable) @NotNull public ComponentReference getComponentRef()
      A reference to a Component resource.
      Specified by:
      getComponentRef in interface IComponentRef

    • getComponentName

      @Stability(Stable) @Nullable public String getComponentName()
      The name of the component.

    • setComponentName

      @Stability(Stable) public void setComponentName(@Nullable String value)
      The name of the component.

    • getTags

      @Stability(Stable) @Nullable public List<CfnComponent.TagsItemsProperty> getTags()
      Tags associated with the component.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnComponent.TagsItemsProperty> value)
      Tags associated with the component.