1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotwireless
  5. TaskDefinition

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.iotwireless.TaskDefinition

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Creates a gateway task definition.

    Create TaskDefinition Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TaskDefinition(name: string, args: TaskDefinitionArgs, opts?: CustomResourceOptions);
    @overload
    def TaskDefinition(resource_name: str,
                       args: TaskDefinitionArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def TaskDefinition(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       auto_create_tasks: Optional[bool] = None,
                       lo_ra_wan_update_gateway_task_entry: Optional[TaskDefinitionLoRaWanUpdateGatewayTaskEntryArgs] = None,
                       name: Optional[str] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                       task_definition_type: Optional[TaskDefinitionType] = None,
                       update: Optional[TaskDefinitionUpdateWirelessGatewayTaskCreateArgs] = None)
    func NewTaskDefinition(ctx *Context, name string, args TaskDefinitionArgs, opts ...ResourceOption) (*TaskDefinition, error)
    public TaskDefinition(string name, TaskDefinitionArgs args, CustomResourceOptions? opts = null)
    public TaskDefinition(String name, TaskDefinitionArgs args)
    public TaskDefinition(String name, TaskDefinitionArgs args, CustomResourceOptions options)
    
    type: aws-native:iotwireless:TaskDefinition
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TaskDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TaskDefinitionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TaskDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TaskDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TaskDefinitionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    TaskDefinition Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TaskDefinition resource accepts the following input properties:

    AutoCreateTasks bool
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    LoRaWanUpdateGatewayTaskEntry Pulumi.AwsNative.IoTWireless.Inputs.TaskDefinitionLoRaWanUpdateGatewayTaskEntry
    The list of task definitions.
    Name string
    The name of the new resource.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that contain metadata for the destination.
    TaskDefinitionType Pulumi.AwsNative.IoTWireless.TaskDefinitionType
    A filter to list only the wireless gateway task definitions that use this task definition type
    Update Pulumi.AwsNative.IoTWireless.Inputs.TaskDefinitionUpdateWirelessGatewayTaskCreate
    Information about the gateways to update.
    AutoCreateTasks bool
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    LoRaWanUpdateGatewayTaskEntry TaskDefinitionLoRaWanUpdateGatewayTaskEntryArgs
    The list of task definitions.
    Name string
    The name of the new resource.
    Tags TagArgs
    A list of key-value pairs that contain metadata for the destination.
    TaskDefinitionType TaskDefinitionType
    A filter to list only the wireless gateway task definitions that use this task definition type
    Update TaskDefinitionUpdateWirelessGatewayTaskCreateArgs
    Information about the gateways to update.
    autoCreateTasks Boolean
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    loRaWanUpdateGatewayTaskEntry TaskDefinitionLoRaWanUpdateGatewayTaskEntry
    The list of task definitions.
    name String
    The name of the new resource.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the destination.
    taskDefinitionType TaskDefinitionType
    A filter to list only the wireless gateway task definitions that use this task definition type
    update TaskDefinitionUpdateWirelessGatewayTaskCreate
    Information about the gateways to update.
    autoCreateTasks boolean
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    loRaWanUpdateGatewayTaskEntry TaskDefinitionLoRaWanUpdateGatewayTaskEntry
    The list of task definitions.
    name string
    The name of the new resource.
    tags Tag[]
    A list of key-value pairs that contain metadata for the destination.
    taskDefinitionType TaskDefinitionType
    A filter to list only the wireless gateway task definitions that use this task definition type
    update TaskDefinitionUpdateWirelessGatewayTaskCreate
    Information about the gateways to update.
    auto_create_tasks bool
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    lo_ra_wan_update_gateway_task_entry TaskDefinitionLoRaWanUpdateGatewayTaskEntryArgs
    The list of task definitions.
    name str
    The name of the new resource.
    tags Sequence[TagArgs]
    A list of key-value pairs that contain metadata for the destination.
    task_definition_type TaskDefinitionType
    A filter to list only the wireless gateway task definitions that use this task definition type
    update TaskDefinitionUpdateWirelessGatewayTaskCreateArgs
    Information about the gateways to update.
    autoCreateTasks Boolean
    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    loRaWanUpdateGatewayTaskEntry Property Map
    The list of task definitions.
    name String
    The name of the new resource.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the destination.
    taskDefinitionType "UPDATE"
    A filter to list only the wireless gateway task definitions that use this task definition type
    update Property Map
    Information about the gateways to update.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TaskDefinition resource produces the following output properties:

    Arn string
    TaskDefinition arn. Returned after successful create.
    AwsId string
    The ID of the new wireless gateway task definition
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    TaskDefinition arn. Returned after successful create.
    AwsId string
    The ID of the new wireless gateway task definition
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    TaskDefinition arn. Returned after successful create.
    awsId String
    The ID of the new wireless gateway task definition
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    TaskDefinition arn. Returned after successful create.
    awsId string
    The ID of the new wireless gateway task definition
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    TaskDefinition arn. Returned after successful create.
    aws_id str
    The ID of the new wireless gateway task definition
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    TaskDefinition arn. Returned after successful create.
    awsId String
    The ID of the new wireless gateway task definition
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TaskDefinitionLoRaWanGatewayVersion, TaskDefinitionLoRaWanGatewayVersionArgs

    Model string
    The model number of the wireless gateway.
    PackageVersion string
    The version of the wireless gateway firmware.
    Station string
    The basic station version of the wireless gateway.
    Model string
    The model number of the wireless gateway.
    PackageVersion string
    The version of the wireless gateway firmware.
    Station string
    The basic station version of the wireless gateway.
    model String
    The model number of the wireless gateway.
    packageVersion String
    The version of the wireless gateway firmware.
    station String
    The basic station version of the wireless gateway.
    model string
    The model number of the wireless gateway.
    packageVersion string
    The version of the wireless gateway firmware.
    station string
    The basic station version of the wireless gateway.
    model str
    The model number of the wireless gateway.
    package_version str
    The version of the wireless gateway firmware.
    station str
    The basic station version of the wireless gateway.
    model String
    The model number of the wireless gateway.
    packageVersion String
    The version of the wireless gateway firmware.
    station String
    The basic station version of the wireless gateway.

    TaskDefinitionLoRaWanUpdateGatewayTaskCreate, TaskDefinitionLoRaWanUpdateGatewayTaskCreateArgs

    CurrentVersion Pulumi.AwsNative.IoTWireless.Inputs.TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    SigKeyCrc int
    The CRC of the signature private key to check.
    UpdateSignature string
    The signature used to verify the update firmware.
    UpdateVersion Pulumi.AwsNative.IoTWireless.Inputs.TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    CurrentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    SigKeyCrc int
    The CRC of the signature private key to check.
    UpdateSignature string
    The signature used to verify the update firmware.
    UpdateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    sigKeyCrc Integer
    The CRC of the signature private key to check.
    updateSignature String
    The signature used to verify the update firmware.
    updateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    sigKeyCrc number
    The CRC of the signature private key to check.
    updateSignature string
    The signature used to verify the update firmware.
    updateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    current_version TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    sig_key_crc int
    The CRC of the signature private key to check.
    update_signature str
    The signature used to verify the update firmware.
    update_version TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion Property Map
    The version of the gateways that should receive the update.
    sigKeyCrc Number
    The CRC of the signature private key to check.
    updateSignature String
    The signature used to verify the update firmware.
    updateVersion Property Map
    The firmware version to update the gateway to.

    TaskDefinitionLoRaWanUpdateGatewayTaskEntry, TaskDefinitionLoRaWanUpdateGatewayTaskEntryArgs

    CurrentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    UpdateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    updateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    updateVersion TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    current_version TaskDefinitionLoRaWanGatewayVersion
    The version of the gateways that should receive the update.
    update_version TaskDefinitionLoRaWanGatewayVersion
    The firmware version to update the gateway to.
    currentVersion Property Map
    The version of the gateways that should receive the update.
    updateVersion Property Map
    The firmware version to update the gateway to.

    TaskDefinitionType, TaskDefinitionTypeArgs

    Update
    UPDATE
    TaskDefinitionTypeUpdate
    UPDATE
    Update
    UPDATE
    Update
    UPDATE
    UPDATE
    UPDATE
    "UPDATE"
    UPDATE

    TaskDefinitionUpdateWirelessGatewayTaskCreate, TaskDefinitionUpdateWirelessGatewayTaskCreateArgs

    LoRaWan Pulumi.AwsNative.IoTWireless.Inputs.TaskDefinitionLoRaWanUpdateGatewayTaskCreate
    The properties that relate to the LoRaWAN wireless gateway.
    UpdateDataRole string
    The IAM role used to read data from the S3 bucket.
    UpdateDataSource string
    The link to the S3 bucket.
    LoRaWan TaskDefinitionLoRaWanUpdateGatewayTaskCreate
    The properties that relate to the LoRaWAN wireless gateway.
    UpdateDataRole string
    The IAM role used to read data from the S3 bucket.
    UpdateDataSource string
    The link to the S3 bucket.
    loRaWan TaskDefinitionLoRaWanUpdateGatewayTaskCreate
    The properties that relate to the LoRaWAN wireless gateway.
    updateDataRole String
    The IAM role used to read data from the S3 bucket.
    updateDataSource String
    The link to the S3 bucket.
    loRaWan TaskDefinitionLoRaWanUpdateGatewayTaskCreate
    The properties that relate to the LoRaWAN wireless gateway.
    updateDataRole string
    The IAM role used to read data from the S3 bucket.
    updateDataSource string
    The link to the S3 bucket.
    lo_ra_wan TaskDefinitionLoRaWanUpdateGatewayTaskCreate
    The properties that relate to the LoRaWAN wireless gateway.
    update_data_role str
    The IAM role used to read data from the S3 bucket.
    update_data_source str
    The link to the S3 bucket.
    loRaWan Property Map
    The properties that relate to the LoRaWAN wireless gateway.
    updateDataRole String
    The IAM role used to read data from the S3 bucket.
    updateDataSource String
    The link to the S3 bucket.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi