Skip to content
v2.278.0

CfnTaskDefinitionProps Struct ​

Properties for defining a CfnTaskDefinition.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotwireless as iotwireless } from 'aws-cdk-lib';
const cfnTaskDefinitionProps: iotwireless.CfnTaskDefinitionProps = {
  autoCreateTasks: false,

  // the properties below are optional
  loRaWanUpdateGatewayTaskEntry: {
    currentVersion: {
      model: 'model',
      packageVersion: 'packageVersion',
      station: 'station',
    },
    updateVersion: {
      model: 'model',
      packageVersion: 'packageVersion',
      station: 'station',
    },
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskDefinitionType: 'taskDefinitionType',
  update: {
    loRaWan: {
      currentVersion: {
        model: 'model',
        packageVersion: 'packageVersion',
        station: 'station',
      },
      sigKeyCrc: 123,
      updateSignature: 'updateSignature',
      updateVersion: {
        model: 'model',
        packageVersion: 'packageVersion',
        station: 'station',
      },
    },
    updateDataRole: 'updateDataRole',
    updateDataSource: 'updateDataSource',
  },
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotwireless as iotwireless

cfn_task_definition_props = iotwireless.CfnTaskDefinitionProps(
    auto_create_tasks=False,

    # the properties below are optional
    lo_ra_wan_update_gateway_task_entry=iotwireless.CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty(
        current_version=iotwireless.CfnTaskDefinition.LoRaWANGatewayVersionProperty(
            model="model",
            package_version="packageVersion",
            station="station"
        ),
        update_version=iotwireless.CfnTaskDefinition.LoRaWANGatewayVersionProperty(
            model="model",
            package_version="packageVersion",
            station="station"
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_definition_type="taskDefinitionType",
    update=iotwireless.CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty(
        lo_ra_wan=iotwireless.CfnTaskDefinition.LoRaWANUpdateGatewayTaskCreateProperty(
            current_version=iotwireless.CfnTaskDefinition.LoRaWANGatewayVersionProperty(
                model="model",
                package_version="packageVersion",
                station="station"
            ),
            sig_key_crc=123,
            update_signature="updateSignature",
            update_version=iotwireless.CfnTaskDefinition.LoRaWANGatewayVersionProperty(
                model="model",
                package_version="packageVersion",
                station="station"
            )
        ),
        update_data_role="updateDataRole",
        update_data_source="updateDataSource"
    )
)
java
// 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.*;

CfnTaskDefinitionProps cfnTaskDefinitionProps = CfnTaskDefinitionProps.builder()
        .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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTWireless;

var cfnTaskDefinitionProps = new CfnTaskDefinitionProps {
    AutoCreateTasks = false,

    // the properties below are optional
    LoRaWanUpdateGatewayTaskEntry = new LoRaWANUpdateGatewayTaskEntryProperty {
        CurrentVersion = new LoRaWANGatewayVersionProperty {
            Model = "model",
            PackageVersion = "packageVersion",
            Station = "station"
        },
        UpdateVersion = new LoRaWANGatewayVersionProperty {
            Model = "model",
            PackageVersion = "packageVersion",
            Station = "station"
        }
    },
    Name = "name",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TaskDefinitionType = "taskDefinitionType",
    Update = new UpdateWirelessGatewayTaskCreateProperty {
        LoRaWan = new LoRaWANUpdateGatewayTaskCreateProperty {
            CurrentVersion = new LoRaWANGatewayVersionProperty {
                Model = "model",
                PackageVersion = "packageVersion",
                Station = "station"
            },
            SigKeyCrc = 123,
            UpdateSignature = "updateSignature",
            UpdateVersion = new LoRaWANGatewayVersionProperty {
                Model = "model",
                PackageVersion = "packageVersion",
                Station = "station"
            }
        },
        UpdateDataRole = "updateDataRole",
        UpdateDataSource = "updateDataSource"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnTaskDefinitionProps := &CfnTaskDefinitionProps{
	AutoCreateTasks: jsii.Boolean(false),

	// the properties below are optional
	LoRaWanUpdateGatewayTaskEntry: &LoRaWANUpdateGatewayTaskEntryProperty{
		CurrentVersion: &LoRaWANGatewayVersionProperty{
			Model: jsii.String("model"),
			PackageVersion: jsii.String("packageVersion"),
			Station: jsii.String("station"),
		},
		UpdateVersion: &LoRaWANGatewayVersionProperty{
			Model: jsii.String("model"),
			PackageVersion: jsii.String("packageVersion"),
			Station: jsii.String("station"),
		},
	},
	Name: jsii.String("name"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TaskDefinitionType: jsii.String("taskDefinitionType"),
	Update: &UpdateWirelessGatewayTaskCreateProperty{
		LoRaWan: &LoRaWANUpdateGatewayTaskCreateProperty{
			CurrentVersion: &LoRaWANGatewayVersionProperty{
				Model: jsii.String("model"),
				PackageVersion: jsii.String("packageVersion"),
				Station: jsii.String("station"),
			},
			SigKeyCrc: jsii.Number(123),
			UpdateSignature: jsii.String("updateSignature"),
			UpdateVersion: &LoRaWANGatewayVersionProperty{
				Model: jsii.String("model"),
				PackageVersion: jsii.String("packageVersion"),
				Station: jsii.String("station"),
			},
		},
		UpdateDataRole: jsii.String("updateDataRole"),
		UpdateDataSource: jsii.String("updateDataSource"),
	},
}

Properties ​

autoCreateTasksboolean | IResolvableauto_create_taskstyping.Union[bool, IResolvable]autoCreateTasksBooleanAutoCreateTasksboolAutoCreateTasksinterface{} required #
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 .

loRaWanUpdateGatewayTaskEntryoptionalIResolvable | CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryPropertylo_ra_wan_update_gateway_task_entryoptionaltyping.Union[IResolvable, LoRaWANUpdateGatewayTaskEntryProperty]loRaWanUpdateGatewayTaskEntryoptionalIResolvableLoRaWanUpdateGatewayTaskEntryoptionalIResolvableLoRaWanUpdateGatewayTaskEntryoptionalinterface{} #
LoRaWANUpdateGatewayTaskEntry object.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string #
The name of the new resource.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
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.

taskDefinitionTypeoptionalstringtask_definition_typeoptionalstrtaskDefinitionTypeoptionalStringTaskDefinitionTypeoptionalstringTaskDefinitionTypeoptional*string #
A filter to list only the wireless gateway task definitions that use this task definition type.
updateoptionalIResolvable | CfnTaskDefinition.UpdateWirelessGatewayTaskCreatePropertyupdateoptionaltyping.Union[IResolvable, UpdateWirelessGatewayTaskCreateProperty]updateoptionalIResolvableUpdateoptionalIResolvableUpdateoptionalinterface{} #
Information about the gateways to update.