software.amazon.awscdk.services.ec2

Class CfnEnclaveCertificateIamRoleAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnEnclaveCertificateIamRoleAssociation

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.168Z")
 @Stability(value=Stable)
public class CfnEnclaveCertificateIamRoleAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::EnclaveCertificateIamRoleAssociation`.

Associates an AWS Identity and Access Management (IAM) role with an AWS 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 AWS Certificate Manager for Nitro Enclaves in the AWS 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 AWS 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 AWS Nitro Enclaves User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnEnclaveCertificateIamRoleAssociation cfnEnclaveCertificateIamRoleAssociation = CfnEnclaveCertificateIamRoleAssociation.Builder.create(this, "MyCfnEnclaveCertificateIamRoleAssociation")
         .certificateArn("certificateArn")
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnclaveCertificateIamRoleAssociation.Builder A fluent builder for CfnEnclaveCertificateIamRoleAssociation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnclaveCertificateIamRoleAssociation(software.constructs.Construct scope, String id, CfnEnclaveCertificateIamRoleAssociationProps props) Create a new `AWS::EC2::EnclaveCertificateIamRoleAssociation`.
protected	CfnEnclaveCertificateIamRoleAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnclaveCertificateIamRoleAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCertificateS3BucketName() The name of the Amazon S3 bucket to which the certificate was uploaded.
String	getAttrCertificateS3ObjectKey() The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
String	getAttrEncryptionKmsKeyId() The ID of the AWS KMS key used to encrypt the private key of the certificate.
String	getCertificateArn() The ARN of the ACM certificate with which to associate the IAM role.
protected Map<String,Object>	getCfnProperties()
String	getRoleArn() The ARN of the IAM role to associate with the ACM certificate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateArn(String value) The ARN of the ACM certificate with which to associate the IAM role.
void	setRoleArn(String value) The ARN of the IAM role to associate with the ACM certificate.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnclaveCertificateIamRoleAssociation

protected CfnEnclaveCertificateIamRoleAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnclaveCertificateIamRoleAssociation

protected CfnEnclaveCertificateIamRoleAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnclaveCertificateIamRoleAssociation

@Stability(value=Stable)
public CfnEnclaveCertificateIamRoleAssociation(@NotNull
                                                                        software.constructs.Construct scope,
                                                                        @NotNull
                                                                        String id,
                                                                        @NotNull
                                                                        CfnEnclaveCertificateIamRoleAssociationProps props)

Create a new `AWS::EC2::EnclaveCertificateIamRoleAssociation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCertificateS3BucketName

@Stability(value=Stable)
 @NotNull
public String getAttrCertificateS3BucketName()

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

getAttrCertificateS3ObjectKey

@Stability(value=Stable)
 @NotNull
public String getAttrCertificateS3ObjectKey()

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 .

getAttrEncryptionKmsKeyId

@Stability(value=Stable)
 @NotNull
public String getAttrEncryptionKmsKeyId()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCertificateArn

@Stability(value=Stable)
 @NotNull
public String getCertificateArn()

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

setCertificateArn

@Stability(value=Stable)
public void setCertificateArn(@NotNull
                                                       String value)

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

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

You can associate up to 16 IAM roles with an ACM certificate.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

You can associate up to 16 IAM roles with an ACM certificate.