AssociateEnclaveCertificateIamRole - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AssociateEnclaveCertificateIamRole

Associates an Amazon Identity and Access Management (IAM) role with an Amazon Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Amazon Certificate Manager for Nitro Enclaves in the Amazon Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Nitro Enclaves User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

CertificateArn

The ARN of the ACM certificate with which to associate the IAM role.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1283.

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

RoleArn

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1283.

Required: No

Response Elements

The following elements are returned by the service.

certificateS3BucketName

The name of the Amazon S3 bucket to which the certificate was uploaded.

Type: String

certificateS3ObjectKey

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.

Type: String

encryptionKmsKeyId

The ID of the KMS key used to encrypt the private key of the certificate.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.