CfnTaskDefinition

class aws_cdk.aws_iotwireless.CfnTaskDefinition(scope, id, *, auto_create_tasks, lo_ra_wan_update_gateway_task_entry=None, name=None, tags=None, task_definition_type=None, update=None)

Bases: CfnResource

A CloudFormation AWS::IoTWireless::TaskDefinition.

Creates a gateway task definition.

CloudformationResource:

AWS::IoTWireless::TaskDefinition

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotwireless as iotwireless

cfn_task_definition = iotwireless.CfnTaskDefinition(self, "MyCfnTaskDefinition",
    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"
    )
)

Create a new AWS::IoTWireless::TaskDefinition.

Parameters:

• scope (Construct) –

  • scope in which this resource is defined.

• id (str) –

  • scoped id of the resource.

• auto_create_tasks (Union[bool, IResolvable]) – 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 .

• lo_ra_wan_update_gateway_task_entry (Union[IResolvable, LoRaWANUpdateGatewayTaskEntryProperty, Dict[str, Any], None]) – AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry.

• name (Optional[str]) – The name of the new resource.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

• task_definition_type (Optional[str]) – AWS::IoTWireless::TaskDefinition.TaskDefinitionType.

• update (Union[IResolvable, UpdateWirelessGatewayTaskCreateProperty, Dict[str, Any], None]) – Information about the gateways to update.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str) –

• value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

• policy (Optional[RemovalPolicy]) –

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

• tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTWireless::TaskDefinition'

attr_arn

The Amazon Resource Name of the resource.

CloudformationAttribute:

Arn

attr_id

The ID of the new wireless gateway task definition.

CloudformationAttribute:

Id

auto_create_tasks

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-autocreatetasks

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

lo_ra_wan_update_gateway_task_entry

AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the new resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-name

node

The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-tags

task_definition_type

AWS::IoTWireless::TaskDefinition.TaskDefinitionType.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-taskdefinitiontype

update

Information about the gateways to update.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-update

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

LoRaWANGatewayVersionProperty

class CfnTaskDefinition.LoRaWANGatewayVersionProperty(*, model=None, package_version=None, station=None)

Bases: object

LoRaWANGatewayVersion object.

Parameters:

• model (Optional[str]) – The model number of the wireless gateway.

• package_version (Optional[str]) – The version of the wireless gateway firmware.

• station (Optional[str]) – The basic station version of the wireless gateway.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotwireless as iotwireless

lo_ra_wANGateway_version_property = iotwireless.CfnTaskDefinition.LoRaWANGatewayVersionProperty(
    model="model",
    package_version="packageVersion",
    station="station"
)

Attributes

model

The model number of the wireless gateway.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-model

package_version

The version of the wireless gateway firmware.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-packageversion

station

The basic station version of the wireless gateway.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-station

LoRaWANUpdateGatewayTaskCreateProperty

class CfnTaskDefinition.LoRaWANUpdateGatewayTaskCreateProperty(*, current_version=None, sig_key_crc=None, update_signature=None, update_version=None)

Bases: object

The signature used to verify the update firmware.

Parameters:

• current_version (Union[IResolvable, LoRaWANGatewayVersionProperty, Dict[str, Any], None]) – The version of the gateways that should receive the update.

• sig_key_crc (Union[int, float, None]) – The CRC of the signature private key to check.

• update_signature (Optional[str]) – The signature used to verify the update firmware.

• update_version (Union[IResolvable, LoRaWANGatewayVersionProperty, Dict[str, Any], None]) – The firmware version to update the gateway to.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotwireless as iotwireless

lo_ra_wANUpdate_gateway_task_create_property = 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"
    )
)

Attributes

current_version

The version of the gateways that should receive the update.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-currentversion

sig_key_crc

The CRC of the signature private key to check.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-sigkeycrc

update_signature

The signature used to verify the update firmware.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updatesignature

update_version

The firmware version to update the gateway to.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updateversion

LoRaWANUpdateGatewayTaskEntryProperty

class CfnTaskDefinition.LoRaWANUpdateGatewayTaskEntryProperty(*, current_version=None, update_version=None)

Bases: object

LoRaWANUpdateGatewayTaskEntry object.

Parameters:

• current_version (Union[IResolvable, LoRaWANGatewayVersionProperty, Dict[str, Any], None]) – The version of the gateways that should receive the update.

• update_version (Union[IResolvable, LoRaWANGatewayVersionProperty, Dict[str, Any], None]) – The firmware version to update the gateway to.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotwireless as iotwireless

lo_ra_wANUpdate_gateway_task_entry_property = 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"
    )
)

Attributes

current_version

The version of the gateways that should receive the update.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-currentversion

update_version

The firmware version to update the gateway to.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-updateversion

UpdateWirelessGatewayTaskCreateProperty

class CfnTaskDefinition.UpdateWirelessGatewayTaskCreateProperty(*, lo_ra_wan=None, update_data_role=None, update_data_source=None)

Bases: object

UpdateWirelessGatewayTaskCreate object.

Parameters:

• lo_ra_wan (Union[IResolvable, LoRaWANUpdateGatewayTaskCreateProperty, Dict[str, Any], None]) – The properties that relate to the LoRaWAN wireless gateway.

• update_data_role (Optional[str]) – The IAM role used to read data from the S3 bucket.

• update_data_source (Optional[str]) – The link to the S3 bucket.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotwireless as iotwireless

update_wireless_gateway_task_create_property = 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"
)

Attributes

lo_ra_wan

The properties that relate to the LoRaWAN wireless gateway.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-lorawan

update_data_role

The IAM role used to read data from the S3 bucket.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatarole

update_data_source

The link to the S3 bucket.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatasource