EC2 / Client / associate_enclave_certificate_iam_role

associate_enclave_certificate_iam_role#

EC2.Client.associate_enclave_certificate_iam_role(**kwargs)#

Associates an Identity and Access Management (IAM) role with an 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 Certificate Manager for Nitro Enclaves in the Amazon Web Services 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 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services 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 Web Services Nitro Enclaves User Guide.

See also: AWS API Documentation

Request Syntax

response = client.associate_enclave_certificate_iam_role(
    CertificateArn='string',
    RoleArn='string',
    DryRun=True|False
)
Parameters:

  • CertificateArn (string) –

    [REQUIRED]

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

  • RoleArn (string) –

    [REQUIRED]

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

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'CertificateS3BucketName': 'string',
    'CertificateS3ObjectKey': 'string',
    'EncryptionKmsKeyId': 'string'
}

Response Structure

  • (dict) –

    • CertificateS3BucketName (string) –

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

    • CertificateS3ObjectKey (string) –

      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.

    • EncryptionKmsKeyId (string) –

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