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
aws-native.iot.getEncryptionConfiguration
Explore with Pulumi AI
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
Resource Type definition for AWS::IoT::EncryptionConfiguration
Using getEncryptionConfiguration
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 getEncryptionConfiguration(args: GetEncryptionConfigurationArgs, opts?: InvokeOptions): Promise<GetEncryptionConfigurationResult>
function getEncryptionConfigurationOutput(args: GetEncryptionConfigurationOutputArgs, opts?: InvokeOptions): Output<GetEncryptionConfigurationResult>
def get_encryption_configuration(account_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEncryptionConfigurationResult
def get_encryption_configuration_output(account_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEncryptionConfigurationResult]
func LookupEncryptionConfiguration(ctx *Context, args *LookupEncryptionConfigurationArgs, opts ...InvokeOption) (*LookupEncryptionConfigurationResult, error)
func LookupEncryptionConfigurationOutput(ctx *Context, args *LookupEncryptionConfigurationOutputArgs, opts ...InvokeOption) LookupEncryptionConfigurationResultOutput
> Note: This function is named LookupEncryptionConfiguration
in the Go SDK.
public static class GetEncryptionConfiguration
{
public static Task<GetEncryptionConfigurationResult> InvokeAsync(GetEncryptionConfigurationArgs args, InvokeOptions? opts = null)
public static Output<GetEncryptionConfigurationResult> Invoke(GetEncryptionConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEncryptionConfigurationResult> getEncryptionConfiguration(GetEncryptionConfigurationArgs args, InvokeOptions options)
public static Output<GetEncryptionConfigurationResult> getEncryptionConfiguration(GetEncryptionConfigurationArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:iot:getEncryptionConfiguration
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Id string - The unique identifier (ID) of an AWS account.
- Account
Id string - The unique identifier (ID) of an AWS account.
- account
Id String - The unique identifier (ID) of an AWS account.
- account
Id string - The unique identifier (ID) of an AWS account.
- account_
id str - The unique identifier (ID) of an AWS account.
- account
Id String - The unique identifier (ID) of an AWS account.
getEncryptionConfiguration Result
The following output properties are available:
- Account
Id string - The unique identifier (ID) of an AWS account.
- Configuration
Details Pulumi.Aws Native. Io T. Outputs. Configuration Details Properties - Encryption
Type Pulumi.Aws Native. Io T. Encryption Configuration Encryption Type - The type of the KMS key.
- Kms
Access stringRole Arn - 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 stringArn - The ARN of the customer managed KMS key.
- Last
Modified stringDate - The date when encryption configuration is last updated.
- Account
Id string - The unique identifier (ID) of an AWS account.
- Configuration
Details ConfigurationDetails Properties - Encryption
Type EncryptionConfiguration Encryption Type - The type of the KMS key.
- Kms
Access stringRole Arn - 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 stringArn - The ARN of the customer managed KMS key.
- Last
Modified stringDate - The date when encryption configuration is last updated.
- account
Id String - The unique identifier (ID) of an AWS account.
- configuration
Details ConfigurationDetails Properties - encryption
Type EncryptionConfiguration Encryption Type - The type of the KMS key.
- kms
Access StringRole Arn - 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 StringArn - The ARN of the customer managed KMS key.
- last
Modified StringDate - The date when encryption configuration is last updated.
- account
Id string - The unique identifier (ID) of an AWS account.
- configuration
Details ConfigurationDetails Properties - encryption
Type EncryptionConfiguration Encryption Type - The type of the KMS key.
- kms
Access stringRole Arn - 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 stringArn - The ARN of the customer managed KMS key.
- last
Modified stringDate - The date when encryption configuration is last updated.
- account_
id str - The unique identifier (ID) of an AWS account.
- configuration_
details ConfigurationDetails Properties - encryption_
type EncryptionConfiguration Encryption Type - The type of the KMS key.
- kms_
access_ strrole_ arn - 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_ strarn - The ARN of the customer managed KMS key.
- last_
modified_ strdate - The date when encryption configuration is last updated.
- account
Id String - The unique identifier (ID) of an AWS account.
- configuration
Details Property Map - encryption
Type "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KMS_KEY" - The type of the KMS key.
- kms
Access StringRole Arn - 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 StringArn - The ARN of the customer managed KMS key.
- last
Modified StringDate - The date when encryption configuration is last updated.
Supporting Types
ConfigurationDetailsProperties
- Configuration
Status Pulumi.Aws Native. Io T. Encryption Configuration Configuration Details Properties Configuration Status - 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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - Error
Code string - The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
. - Error
Message string - The detailed error message that corresponds to the
errorCode
.
- Configuration
Status EncryptionConfiguration Configuration Details Properties Configuration Status - 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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - Error
Code string - The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
. - Error
Message string - The detailed error message that corresponds to the
errorCode
.
- configuration
Status EncryptionConfiguration Configuration Details Properties Configuration Status - 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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - error
Code String - The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
. - error
Message String - The detailed error message that corresponds to the
errorCode
.
- configuration
Status EncryptionConfiguration Configuration Details Properties Configuration Status - 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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - error
Code string - The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
. - error
Message string - The detailed error message that corresponds to the
errorCode
.
- configuration_
status EncryptionConfiguration Configuration Details Properties Configuration Status - 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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - 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
andROLE_VALIDATION_ERROR
. - error_
message str - The detailed error message that corresponds to the
errorCode
.
- configuration
Status "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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - error
Code String - The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
. - error
Message String - The detailed error message that corresponds to the
errorCode
.
EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus
EncryptionConfigurationEncryptionType
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
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