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

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

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.EncryptionConfiguration

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.35.0 published on Monday, Sep 22, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoT::EncryptionConfiguration

    Create EncryptionConfiguration Resource

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

    Constructor syntax

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

@overload
def EncryptionConfiguration(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            encryption_type: Optional[EncryptionConfigurationEncryptionType] = None,
                            kms_access_role_arn: Optional[str] = None,
                            kms_key_arn: Optional[str] = None)
    func NewEncryptionConfiguration(ctx *Context, name string, args EncryptionConfigurationArgs, opts ...ResourceOption) (*EncryptionConfiguration, error)
    public EncryptionConfiguration(string name, EncryptionConfigurationArgs args, CustomResourceOptions? opts = null)
    public EncryptionConfiguration(String name, EncryptionConfigurationArgs args)
public EncryptionConfiguration(String name, EncryptionConfigurationArgs args, CustomResourceOptions options)

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

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

    EncryptionType Pulumi.AwsNative.IoT.EncryptionConfigurationEncryptionType
    The type of the KMS key.
    KmsAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    KmsKeyArn string
    The ARN of the customer managed KMS key.
    EncryptionType EncryptionConfigurationEncryptionType
    The type of the KMS key.
    KmsAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    KmsKeyArn string
    The ARN of the customer managed KMS key.
    encryptionType EncryptionConfigurationEncryptionType
    The type of the KMS key.
    kmsAccessRoleArn String
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    kmsKeyArn String
    The ARN of the customer managed KMS key.
    encryptionType EncryptionConfigurationEncryptionType
    The type of the KMS key.
    kmsAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    kmsKeyArn string
    The ARN of the customer managed KMS key.
    encryption_type EncryptionConfigurationEncryptionType
    The type of the KMS key.
    kms_access_role_arn str
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    kms_key_arn str
    The ARN of the customer managed KMS key.
    encryptionType "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KMS_KEY"
    The type of the KMS key.
    kmsAccessRoleArn String
    The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
    kmsKeyArn String
    The ARN of the customer managed KMS key.

    Outputs

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

    AccountId string
    The unique identifier (ID) of an AWS account.
    ConfigurationDetails Pulumi.AwsNative.IoT.Outputs.ConfigurationDetailsProperties
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    The date when encryption configuration is last updated.
    AccountId string
    The unique identifier (ID) of an AWS account.
    ConfigurationDetails ConfigurationDetailsProperties
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    The date when encryption configuration is last updated.
    accountId String
    The unique identifier (ID) of an AWS account.
    configurationDetails ConfigurationDetailsProperties
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    The date when encryption configuration is last updated.
    accountId string
    The unique identifier (ID) of an AWS account.
    configurationDetails ConfigurationDetailsProperties
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate string
    The date when encryption configuration is last updated.
    account_id str
    The unique identifier (ID) of an AWS account.
    configuration_details ConfigurationDetailsProperties
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_date str
    The date when encryption configuration is last updated.
    accountId String
    The unique identifier (ID) of an AWS account.
    configurationDetails Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    The date when encryption configuration is last updated.

    Supporting Types

    ConfigurationDetailsProperties, ConfigurationDetailsPropertiesArgs

    ConfigurationStatus Pulumi.AwsNative.IoT.EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    ErrorCode string
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    ErrorMessage string
    The detailed error message that corresponds to the errorCode .
    ConfigurationStatus EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    ErrorCode string
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    ErrorMessage string
    The detailed error message that corresponds to the errorCode .
    configurationStatus EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    errorCode String
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    errorMessage String
    The detailed error message that corresponds to the errorCode .
    configurationStatus EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    errorCode string
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    errorMessage string
    The detailed error message that corresponds to the errorCode .
    configuration_status EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    error_code str
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    error_message str
    The detailed error message that corresponds to the errorCode .
    configurationStatus "HEALTHY" | "UNHEALTHY"
    The health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role is UNHEALTHY , the return value will be UNHEALTHY . To use a customer managed KMS key, the value of configurationStatus must be HEALTHY .
    errorCode String
    The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY . Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .
    errorMessage String
    The detailed error message that corresponds to the errorCode .

    EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus, EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatusArgs

    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatusHealthy
    HEALTHY
    EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatusUnhealthy
    UNHEALTHY
    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    HEALTHY
    HEALTHY
    UNHEALTHY
    UNHEALTHY
    "HEALTHY"
    HEALTHY
    "UNHEALTHY"
    UNHEALTHY

    EncryptionConfigurationEncryptionType, EncryptionConfigurationEncryptionTypeArgs

    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    EncryptionConfigurationEncryptionTypeCustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    EncryptionConfigurationEncryptionTypeAwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CUSTOMER_MANAGED_KMS_KEY
    CUSTOMER_MANAGED_KMS_KEY
    AWS_OWNED_KMS_KEY
    AWS_OWNED_KMS_KEY
    "CUSTOMER_MANAGED_KMS_KEY"
    CUSTOMER_MANAGED_KMS_KEY
    "AWS_OWNED_KMS_KEY"
    AWS_OWNED_KMS_KEY

    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.35.0 published on Monday, Sep 22, 2025 by Pulumi
    pulumi/pulumi-aws-native