1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getProvisioningTemplate

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.iot.getProvisioningTemplate

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Creates a fleet provisioning template.

    Using getProvisioningTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProvisioningTemplate(args: GetProvisioningTemplateArgs, opts?: InvokeOptions): Promise<GetProvisioningTemplateResult>
    function getProvisioningTemplateOutput(args: GetProvisioningTemplateOutputArgs, opts?: InvokeOptions): Output<GetProvisioningTemplateResult>
    def get_provisioning_template(template_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetProvisioningTemplateResult
    def get_provisioning_template_output(template_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetProvisioningTemplateResult]
    func LookupProvisioningTemplate(ctx *Context, args *LookupProvisioningTemplateArgs, opts ...InvokeOption) (*LookupProvisioningTemplateResult, error)
    func LookupProvisioningTemplateOutput(ctx *Context, args *LookupProvisioningTemplateOutputArgs, opts ...InvokeOption) LookupProvisioningTemplateResultOutput

    > Note: This function is named LookupProvisioningTemplate in the Go SDK.

    public static class GetProvisioningTemplate 
    {
        public static Task<GetProvisioningTemplateResult> InvokeAsync(GetProvisioningTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetProvisioningTemplateResult> Invoke(GetProvisioningTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProvisioningTemplateResult> getProvisioningTemplate(GetProvisioningTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iot:getProvisioningTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TemplateName string
    The name of the fleet provisioning template.
    TemplateName string
    The name of the fleet provisioning template.
    templateName String
    The name of the fleet provisioning template.
    templateName string
    The name of the fleet provisioning template.
    template_name str
    The name of the fleet provisioning template.
    templateName String
    The name of the fleet provisioning template.

    getProvisioningTemplate Result

    The following output properties are available:

    Description string
    The description of the fleet provisioning template.
    Enabled bool
    True to enable the fleet provisioning template, otherwise false.
    PreProvisioningHook Pulumi.AwsNative.IoT.Outputs.ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook template.
    ProvisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Metadata that can be used to manage the fleet provisioning template.
    TemplateArn string
    The ARN that identifies the provisioning template.
    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 ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook template.
    ProvisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    Tags Tag
    Metadata that can be used to manage the fleet provisioning template.
    TemplateArn string
    The ARN that identifies the provisioning template.
    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.
    provisioningRoleArn String
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    tags List<Tag>
    Metadata that can be used to manage the fleet provisioning template.
    templateArn String
    The ARN that identifies the provisioning template.
    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.
    provisioningRoleArn string
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    tags Tag[]
    Metadata that can be used to manage the fleet provisioning template.
    templateArn string
    The ARN that identifies the provisioning template.
    templateBody string
    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 ProvisioningTemplateProvisioningHook
    Creates a pre-provisioning hook 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.
    tags Sequence[root_Tag]
    Metadata that can be used to manage the fleet provisioning template.
    template_arn str
    The ARN that identifies the provisioning template.
    template_body str
    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.
    provisioningRoleArn String
    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
    tags List<Property Map>
    Metadata that can be used to manage the fleet provisioning template.
    templateArn String
    The ARN that identifies the provisioning template.
    templateBody String
    The JSON formatted contents of the fleet provisioning template version.

    Supporting Types

    ProvisioningTemplateProvisioningHook

    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.

    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 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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi