Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.AssociateEnclaveCertificateIamRole

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data AssociateEnclaveCertificateIamRole Source #

See: newAssociateEnclaveCertificateIamRole smart constructor.

Constructors

AssociateEnclaveCertificateIamRole'

Fields

certificateArn :: Maybe Text
The ARN of the ACM certificate with which to associate the IAM role.
dryRun :: Maybe Bool
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.
roleArn :: Maybe Text
The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.

Instances

Instances details

ToHeaders AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods toHeaders :: AssociateEnclaveCertificateIamRole -> [Header] #
ToPath AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods toPath :: AssociateEnclaveCertificateIamRole -> ByteString #
ToQuery AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods toQuery :: AssociateEnclaveCertificateIamRole -> QueryString #
AWSRequest AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Associated Types type AWSResponse AssociateEnclaveCertificateIamRole # Methods request :: (Service -> Service) -> AssociateEnclaveCertificateIamRole -> Request AssociateEnclaveCertificateIamRole # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateEnclaveCertificateIamRole -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateEnclaveCertificateIamRole))) #
Generic AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Associated Types type Rep AssociateEnclaveCertificateIamRole :: Type -> Type # Methods from :: AssociateEnclaveCertificateIamRole -> Rep AssociateEnclaveCertificateIamRole x # to :: Rep AssociateEnclaveCertificateIamRole x -> AssociateEnclaveCertificateIamRole #
Read AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods readsPrec :: Int -> ReadS AssociateEnclaveCertificateIamRole # readList :: ReadS [AssociateEnclaveCertificateIamRole] # readPrec :: ReadPrec AssociateEnclaveCertificateIamRole # readListPrec :: ReadPrec [AssociateEnclaveCertificateIamRole] #
Show AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods showsPrec :: Int -> AssociateEnclaveCertificateIamRole -> ShowS # show :: AssociateEnclaveCertificateIamRole -> String # showList :: [AssociateEnclaveCertificateIamRole] -> ShowS #
NFData AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods rnf :: AssociateEnclaveCertificateIamRole -> () #
Eq AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods (==) :: AssociateEnclaveCertificateIamRole -> AssociateEnclaveCertificateIamRole -> Bool # (/=) :: AssociateEnclaveCertificateIamRole -> AssociateEnclaveCertificateIamRole -> Bool #
Hashable AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods hashWithSalt :: Int -> AssociateEnclaveCertificateIamRole -> Int # hash :: AssociateEnclaveCertificateIamRole -> Int #
type AWSResponse AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole type AWSResponse AssociateEnclaveCertificateIamRole = AssociateEnclaveCertificateIamRoleResponse
type Rep AssociateEnclaveCertificateIamRole Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole type Rep AssociateEnclaveCertificateIamRole = D1 ('MetaData "AssociateEnclaveCertificateIamRole" "Amazonka.EC2.AssociateEnclaveCertificateIamRole" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateEnclaveCertificateIamRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAssociateEnclaveCertificateIamRole :: AssociateEnclaveCertificateIamRole Source #

Create a value of AssociateEnclaveCertificateIamRole with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateEnclaveCertificateIamRole, associateEnclaveCertificateIamRole_certificateArn - The ARN of the ACM certificate with which to associate the IAM role.

$sel:dryRun:AssociateEnclaveCertificateIamRole', associateEnclaveCertificateIamRole_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.

$sel:roleArn:AssociateEnclaveCertificateIamRole', associateEnclaveCertificateIamRole_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.

Request Lenses

associateEnclaveCertificateIamRole_certificateArn :: Lens' AssociateEnclaveCertificateIamRole (Maybe Text) Source #

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

associateEnclaveCertificateIamRole_dryRun :: Lens' AssociateEnclaveCertificateIamRole (Maybe Bool) Source #

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.

associateEnclaveCertificateIamRole_roleArn :: Lens' AssociateEnclaveCertificateIamRole (Maybe Text) Source #

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

Destructuring the Response

data AssociateEnclaveCertificateIamRoleResponse Source #

See: newAssociateEnclaveCertificateIamRoleResponse smart constructor.

Constructors

AssociateEnclaveCertificateIamRoleResponse'

Fields

certificateS3BucketName :: Maybe Text
The name of the Amazon S3 bucket to which the certificate was uploaded.
certificateS3ObjectKey :: Maybe Text
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 :: Maybe Text
The ID of the KMS key used to encrypt the private key of the certificate.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Associated Types type Rep AssociateEnclaveCertificateIamRoleResponse :: Type -> Type # Methods from :: AssociateEnclaveCertificateIamRoleResponse -> Rep AssociateEnclaveCertificateIamRoleResponse x # to :: Rep AssociateEnclaveCertificateIamRoleResponse x -> AssociateEnclaveCertificateIamRoleResponse #
Read AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods readsPrec :: Int -> ReadS AssociateEnclaveCertificateIamRoleResponse # readList :: ReadS [AssociateEnclaveCertificateIamRoleResponse] # readPrec :: ReadPrec AssociateEnclaveCertificateIamRoleResponse # readListPrec :: ReadPrec [AssociateEnclaveCertificateIamRoleResponse] #
Show AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods showsPrec :: Int -> AssociateEnclaveCertificateIamRoleResponse -> ShowS # show :: AssociateEnclaveCertificateIamRoleResponse -> String # showList :: [AssociateEnclaveCertificateIamRoleResponse] -> ShowS #
NFData AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods rnf :: AssociateEnclaveCertificateIamRoleResponse -> () #
Eq AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole Methods (==) :: AssociateEnclaveCertificateIamRoleResponse -> AssociateEnclaveCertificateIamRoleResponse -> Bool # (/=) :: AssociateEnclaveCertificateIamRoleResponse -> AssociateEnclaveCertificateIamRoleResponse -> Bool #
type Rep AssociateEnclaveCertificateIamRoleResponse Source #
Instance details Defined in Amazonka.EC2.AssociateEnclaveCertificateIamRole type Rep AssociateEnclaveCertificateIamRoleResponse = D1 ('MetaData "AssociateEnclaveCertificateIamRoleResponse" "Amazonka.EC2.AssociateEnclaveCertificateIamRole" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateEnclaveCertificateIamRoleResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateS3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateS3ObjectKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "encryptionKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateEnclaveCertificateIamRoleResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateEnclaveCertificateIamRoleResponse'`
-> AssociateEnclaveCertificateIamRoleResponse

Create a value of AssociateEnclaveCertificateIamRoleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateEnclaveCertificateIamRoleResponse, associateEnclaveCertificateIamRoleResponse_certificateS3BucketName - The name of the Amazon S3 bucket to which the certificate was uploaded.

AssociateEnclaveCertificateIamRoleResponse, associateEnclaveCertificateIamRoleResponse_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.

AssociateEnclaveCertificateIamRoleResponse, associateEnclaveCertificateIamRoleResponse_encryptionKmsKeyId - The ID of the KMS key used to encrypt the private key of the certificate.

$sel:httpStatus:AssociateEnclaveCertificateIamRoleResponse', associateEnclaveCertificateIamRoleResponse_httpStatus - The response's http status code.

Response Lenses

associateEnclaveCertificateIamRoleResponse_certificateS3BucketName :: Lens' AssociateEnclaveCertificateIamRoleResponse (Maybe Text) Source #

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

associateEnclaveCertificateIamRoleResponse_certificateS3ObjectKey :: Lens' AssociateEnclaveCertificateIamRoleResponse (Maybe Text) Source #

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.

associateEnclaveCertificateIamRoleResponse_encryptionKmsKeyId :: Lens' AssociateEnclaveCertificateIamRoleResponse (Maybe Text) Source #

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

associateEnclaveCertificateIamRoleResponse_httpStatus :: Lens' AssociateEnclaveCertificateIamRoleResponse Int Source #

The response's http status code.