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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.iotwireless.TaskDefinition

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeTaskDefinitionResource = new aws_native.iotwireless.TaskDefinition("aws-nativeTaskDefinitionResource", {
        autoCreateTasks: false,
        loRaWanUpdateGatewayTaskEntry: {
            currentVersion: {
                model: "string",
                packageVersion: "string",
                station: "string",
            },
            updateVersion: {
                model: "string",
                packageVersion: "string",
                station: "string",
            },
        },
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        taskDefinitionType: aws_native.iotwireless.TaskDefinitionType.Update,
        update: {
            loRaWan: {
                currentVersion: {
                    model: "string",
                    packageVersion: "string",
                    station: "string",
                },
                sigKeyCrc: 0,
                updateSignature: "string",
                updateVersion: {
                    model: "string",
                    packageVersion: "string",
                    station: "string",
                },
            },
            updateDataRole: "string",
            updateDataSource: "string",
        },
    });
    
    Coming soon!
    

    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

    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
    PackageVersion string
    Station string
    Model string
    PackageVersion string
    Station string
    model String
    packageVersion String
    station String
    model string
    packageVersion string
    station string
    model String
    packageVersion String
    station String

    TaskDefinitionLoRaWanUpdateGatewayTaskCreate, TaskDefinitionLoRaWanUpdateGatewayTaskCreateArgs

    TaskDefinitionLoRaWanUpdateGatewayTaskEntry, TaskDefinitionLoRaWanUpdateGatewayTaskEntryArgs

    TaskDefinitionType, TaskDefinitionTypeArgs

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

    TaskDefinitionUpdateWirelessGatewayTaskCreate, TaskDefinitionUpdateWirelessGatewayTaskCreateArgs

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi