Package software.amazon.awscdk.services.iotwireless

Class CfnTaskDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotwireless.CfnTaskDefinition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.993Z") @Stability(Stable) public class CfnTaskDefinition extends CfnResource implements IInspectable
A CloudFormation AWS::IoTWireless::TaskDefinition.

Creates a gateway task definition.

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.iotwireless.*;
 CfnTaskDefinition cfnTaskDefinition = CfnTaskDefinition.Builder.create(this, "MyCfnTaskDefinition")
         .autoCreateTasks(false)
         // the properties below are optional
         .loRaWanUpdateGatewayTaskEntry(LoRaWANUpdateGatewayTaskEntryProperty.builder()
                 .currentVersion(LoRaWANGatewayVersionProperty.builder()
                         .model("model")
                         .packageVersion("packageVersion")
                         .station("station")
                         .build())
                 .updateVersion(LoRaWANGatewayVersionProperty.builder()
                         .model("model")
                         .packageVersion("packageVersion")
                         .station("station")
                         .build())
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskDefinitionType("taskDefinitionType")
         .update(UpdateWirelessGatewayTaskCreateProperty.builder()
                 .loRaWan(LoRaWANUpdateGatewayTaskCreateProperty.builder()
                         .currentVersion(LoRaWANGatewayVersionProperty.builder()
                                 .model("model")
                                 .packageVersion("packageVersion")
                                 .station("station")
                                 .build())
                         .sigKeyCrc(123)
                         .updateSignature("updateSignature")
                         .updateVersion(LoRaWANGatewayVersionProperty.builder()
                                 .model("model")
                                 .packageVersion("packageVersion")
                                 .station("station")
                                 .build())
                         .build())
                 .updateDataRole("updateDataRole")
                 .updateDataSource("updateDataSource")
                 .build())
         .build();

  • 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

    • CfnTaskDefinition

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

    • CfnTaskDefinition

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

    • CfnTaskDefinition

      @Stability(Stable) public CfnTaskDefinition(@NotNull Construct scope, @NotNull String id, @NotNull CfnTaskDefinitionProps props)
      Create a new AWS::IoTWireless::TaskDefinition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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 Amazon Resource Name of the resource.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the new wireless gateway task definition.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags are an array of key-value pairs to attach to the specified resource.

      Tags can have a minimum of 0 and a maximum of 50 items.

    • getAutoCreateTasks

      @Stability(Stable) @NotNull public Object getAutoCreateTasks()
      Whether to automatically create tasks using this task definition for all gateways with the specified current version.

      If false , the task must be created by calling CreateWirelessGatewayTask .

    • setAutoCreateTasks

      @Stability(Stable) public void setAutoCreateTasks(@NotNull Boolean value)
      Whether to automatically create tasks using this task definition for all gateways with the specified current version.

      If false , the task must be created by calling CreateWirelessGatewayTask .

    • setAutoCreateTasks

      @Stability(Stable) public void setAutoCreateTasks(@NotNull IResolvable value)
      Whether to automatically create tasks using this task definition for all gateways with the specified current version.

      If false , the task must be created by calling CreateWirelessGatewayTask .

    • getLoRaWanUpdateGatewayTaskEntry

      @Stability(Stable) @Nullable public Object getLoRaWanUpdateGatewayTaskEntry()
      AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry.

    • setLoRaWanUpdateGatewayTaskEntry

      @Stability(Stable) public void setLoRaWanUpdateGatewayTaskEntry(@Nullable IResolvable value)
      AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry.

    • setLoRaWanUpdateGatewayTaskEntry

      @Stability(Stable) public void setLoRaWanUpdateGatewayTaskEntry(@Nullable CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty value)
      AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the new resource.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the new resource.

    • getTaskDefinitionType

      @Stability(Stable) @Nullable public String getTaskDefinitionType()
      AWS::IoTWireless::TaskDefinition.TaskDefinitionType.

    • setTaskDefinitionType

      @Stability(Stable) public void setTaskDefinitionType(@Nullable String value)
      AWS::IoTWireless::TaskDefinition.TaskDefinitionType.

    • getUpdate

      @Stability(Stable) @Nullable public Object getUpdate()
      Information about the gateways to update.

    • setUpdate

      @Stability(Stable) public void setUpdate(@Nullable IResolvable value)
      Information about the gateways to update.

    • setUpdate

      @Stability(Stable) public void setUpdate(@Nullable CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty value)
      Information about the gateways to update.