Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. ProvisioningTemplate

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
pulumi/pulumi-aws-native

aws-native.iot.ProvisioningTemplate

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
pulumi/pulumi-aws-native

    Creates a fleet provisioning template.

    Create ProvisioningTemplate Resource

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

    Constructor syntax

    new ProvisioningTemplate(name: string, args: ProvisioningTemplateArgs, opts?: CustomResourceOptions);
    @overload
def ProvisioningTemplate(resource_name: str,
                         args: ProvisioningTemplateArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def ProvisioningTemplate(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         provisioning_role_arn: Optional[str] = None,
                         template_body: Optional[str] = None,
                         description: Optional[str] = None,
                         enabled: Optional[bool] = None,
                         pre_provisioning_hook: Optional[ProvisioningTemplateProvisioningHookArgs] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         template_name: Optional[str] = None,
                         template_type: Optional[ProvisioningTemplateTemplateType] = None)
    func NewProvisioningTemplate(ctx *Context, name string, args ProvisioningTemplateArgs, opts ...ResourceOption) (*ProvisioningTemplate, error)
    public ProvisioningTemplate(string name, ProvisioningTemplateArgs args, CustomResourceOptions? opts = null)
    public ProvisioningTemplate(String name, ProvisioningTemplateArgs args)
public ProvisioningTemplate(String name, ProvisioningTemplateArgs args, CustomResourceOptions options)

    type: aws-native:iot:ProvisioningTemplate
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 ProvisioningTemplateArgs
    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 ProvisioningTemplateArgs
    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 ProvisioningTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProvisioningTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProvisioningTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ProvisioningTemplate 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 ProvisioningTemplate resource accepts the following input properties:

    ProvisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    TemplateBody string
    The JSON formatted contents of the fleet provisioning template version.
    Description string
    The description of the fleet provisioning template.
    Enabled bool
    True to enable the fleet provisioning template, otherwise false.
    PreProvisioningHook Pulumi.AwsNative.IoT.Inputs.ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook template.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Metadata that can be used to manage the fleet provisioning template.
    TemplateName string
    The name of the fleet provisioning template.
    TemplateType Pulumi.AwsNative.IoT.ProvisioningTemplateTemplateType
    The type of the provisioning template.
    ProvisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    TemplateBody string
    The JSON formatted contents of the fleet provisioning template version.
    Description string
    The description of the fleet provisioning template.
    Enabled bool
    True to enable the fleet provisioning template, otherwise false.
    PreProvisioningHook ProvisioningTemplateProvisioningHookArgs
    Creates a pre-provisioning hook template.
    Tags TagArgs
    Metadata that can be used to manage the fleet provisioning template.
    TemplateName string
    The name of the fleet provisioning template.
    TemplateType ProvisioningTemplateTemplateType
    The type of the provisioning template.
    provisioningRoleArn String
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    templateBody String
    The JSON formatted contents of the fleet provisioning template version.
    description String
    The description of the fleet provisioning template.
    enabled Boolean
    True to enable the fleet provisioning template, otherwise false.
    preProvisioningHook ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook template.
    tags List<Tag>
    Metadata that can be used to manage the fleet provisioning template.
    templateName String
    The name of the fleet provisioning template.
    templateType ProvisioningTemplateTemplateType
    The type of the provisioning template.
    provisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    templateBody string
    The JSON formatted contents of the fleet provisioning template version.
    description string
    The description of the fleet provisioning template.
    enabled boolean
    True to enable the fleet provisioning template, otherwise false.
    preProvisioningHook ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook template.
    tags Tag[]
    Metadata that can be used to manage the fleet provisioning template.
    templateName string
    The name of the fleet provisioning template.
    templateType ProvisioningTemplateTemplateType
    The type of the provisioning template.
    provisioning_role_arn str
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    template_body str
    The JSON formatted contents of the fleet provisioning template version.
    description str
    The description of the fleet provisioning template.
    enabled bool
    True to enable the fleet provisioning template, otherwise false.
    pre_provisioning_hook ProvisioningTemplateProvisioningHookArgs
    Creates a pre-provisioning hook template.
    tags Sequence[TagArgs]
    Metadata that can be used to manage the fleet provisioning template.
    template_name str
    The name of the fleet provisioning template.
    template_type ProvisioningTemplateTemplateType
    The type of the provisioning template.
    provisioningRoleArn String
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    templateBody String
    The JSON formatted contents of the fleet provisioning template version.
    description String
    The description of the fleet provisioning template.
    enabled Boolean
    True to enable the fleet provisioning template, otherwise false.
    preProvisioningHook Property Map
    Creates a pre-provisioning hook template.
    tags List<Property Map>
    Metadata that can be used to manage the fleet provisioning template.
    templateName String
    The name of the fleet provisioning template.
    templateType "FLEET_PROVISIONING" | "JITP"
    The type of the provisioning template.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateArn string
    The ARN that identifies the provisioning template.
    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateArn string
    The ARN that identifies the provisioning template.
    id String
    The provider-assigned unique ID for this managed resource.
    templateArn String
    The ARN that identifies the provisioning template.
    id string
    The provider-assigned unique ID for this managed resource.
    templateArn string
    The ARN that identifies the provisioning template.
    id str
    The provider-assigned unique ID for this managed resource.
    template_arn str
    The ARN that identifies the provisioning template.
    id String
    The provider-assigned unique ID for this managed resource.
    templateArn String
    The ARN that identifies the provisioning template.

    Supporting Types

    ProvisioningTemplateProvisioningHook, ProvisioningTemplateProvisioningHookArgs

    PayloadVersion string
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    TargetArn string
    The ARN of the target function.
    PayloadVersion string
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    TargetArn string
    The ARN of the target function.
    payloadVersion String
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    targetArn String
    The ARN of the target function.
    payloadVersion string
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    targetArn string
    The ARN of the target function.
    payload_version str
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    target_arn str
    The ARN of the target function.
    payloadVersion String
    The payload that was sent to the target function. The valid payload is "2020-04-01" .
    targetArn String
    The ARN of the target function.

    ProvisioningTemplateTemplateType, ProvisioningTemplateTemplateTypeArgs

    FleetProvisioning
    FLEET_PROVISIONING
    Jitp
    JITP
    ProvisioningTemplateTemplateTypeFleetProvisioning
    FLEET_PROVISIONING
    ProvisioningTemplateTemplateTypeJitp
    JITP
    FleetProvisioning
    FLEET_PROVISIONING
    Jitp
    JITP
    FleetProvisioning
    FLEET_PROVISIONING
    Jitp
    JITP
    FLEET_PROVISIONING
    FLEET_PROVISIONING
    JITP
    JITP
    "FLEET_PROVISIONING"
    FLEET_PROVISIONING
    "JITP"
    JITP

    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

    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
    pulumi/pulumi-aws-native