associate_enclave_certificate_iam_role¶
Operation¶
associate_enclave_certificate_iam_role
async
¶
associate_enclave_certificate_iam_role(request: AssociateEnclaveCertificateIamRoleInput | AssociateEnclaveCertificateIamRoleInputDict, /, *, plugins: list[Plugin] | None = None) -> AssociateEnclaveCertificateIamRoleOutput
associate_enclave_certificate_iam_role(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateEnclaveCertificateIamRoleInputDict]) -> AssociateEnclaveCertificateIamRoleOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
AssociateEnclaveCertificateIamRoleOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
AssociateEnclaveCertificateIamRoleInput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateEnclaveCertificateIamRoleInput structure.
Attributes¶
certificate_arn
class-attribute
instance-attribute
¶
certificate_arn: str | None = ...
The ARN of the ACM certificate with which to associate the IAM role.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
Dictionaries¶
AssociateEnclaveCertificateIamRoleInputDict
¶
Bases: TypedDict
Dictionary form of AssociateEnclaveCertificateIamRoleInput.
Attributes¶
certificate_arn
instance-attribute
¶
The ARN of the ACM certificate with which to associate the IAM role.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
Output¶
AssociateEnclaveCertificateIamRoleOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateEnclaveCertificateIamRoleOutput structure.
Attributes¶
certificate_s3_bucket_name
class-attribute
instance-attribute
¶
certificate_s3_bucket_name: str | None = ...
The name of the Amazon S3 bucket to which the certificate was uploaded.
certificate_s3_object_key
class-attribute
instance-attribute
¶
certificate_s3_object_key: str | None = ...
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.
encryption_kms_key_id
class-attribute
instance-attribute
¶
encryption_kms_key_id: str | None = ...
The ID of the KMS key used to encrypt the private key of the certificate.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.