software.amazon.awscdk.services.acmpca

Class CfnCertificateAuthority

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.acmpca.CfnCertificateAuthority

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.576Z")
 @Stability(value=Stable)
public class CfnCertificateAuthority
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ACMPCA::CertificateAuthority`.

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.acmpca.*;
 CfnCertificateAuthority cfnCertificateAuthority = CfnCertificateAuthority.Builder.create(this, "MyCfnCertificateAuthority")
         .keyAlgorithm("keyAlgorithm")
         .signingAlgorithm("signingAlgorithm")
         .subject(SubjectProperty.builder()
                 .commonName("commonName")
                 .country("country")
                 .distinguishedNameQualifier("distinguishedNameQualifier")
                 .generationQualifier("generationQualifier")
                 .givenName("givenName")
                 .initials("initials")
                 .locality("locality")
                 .organization("organization")
                 .organizationalUnit("organizationalUnit")
                 .pseudonym("pseudonym")
                 .serialNumber("serialNumber")
                 .state("state")
                 .surname("surname")
                 .title("title")
                 .build())
         .type("type")
         // the properties below are optional
         .csrExtensions(CsrExtensionsProperty.builder()
                 .keyUsage(KeyUsageProperty.builder()
                         .crlSign(false)
                         .dataEncipherment(false)
                         .decipherOnly(false)
                         .digitalSignature(false)
                         .encipherOnly(false)
                         .keyAgreement(false)
                         .keyCertSign(false)
                         .keyEncipherment(false)
                         .nonRepudiation(false)
                         .build())
                 .subjectInformationAccess(List.of(AccessDescriptionProperty.builder()
                         .accessLocation(GeneralNameProperty.builder()
                                 .directoryName(SubjectProperty.builder()
                                         .commonName("commonName")
                                         .country("country")
                                         .distinguishedNameQualifier("distinguishedNameQualifier")
                                         .generationQualifier("generationQualifier")
                                         .givenName("givenName")
                                         .initials("initials")
                                         .locality("locality")
                                         .organization("organization")
                                         .organizationalUnit("organizationalUnit")
                                         .pseudonym("pseudonym")
                                         .serialNumber("serialNumber")
                                         .state("state")
                                         .surname("surname")
                                         .title("title")
                                         .build())
                                 .dnsName("dnsName")
                                 .ediPartyName(EdiPartyNameProperty.builder()
                                         .nameAssigner("nameAssigner")
                                         .partyName("partyName")
                                         .build())
                                 .ipAddress("ipAddress")
                                 .otherName(OtherNameProperty.builder()
                                         .typeId("typeId")
                                         .value("value")
                                         .build())
                                 .registeredId("registeredId")
                                 .rfc822Name("rfc822Name")
                                 .uniformResourceIdentifier("uniformResourceIdentifier")
                                 .build())
                         .accessMethod(AccessMethodProperty.builder()
                                 .accessMethodType("accessMethodType")
                                 .customObjectIdentifier("customObjectIdentifier")
                                 .build())
                         .build()))
                 .build())
         .keyStorageSecurityStandard("keyStorageSecurityStandard")
         .revocationConfiguration(RevocationConfigurationProperty.builder()
                 .crlConfiguration(CrlConfigurationProperty.builder()
                         .customCname("customCname")
                         .enabled(false)
                         .expirationInDays(123)
                         .s3BucketName("s3BucketName")
                         .s3ObjectAcl("s3ObjectAcl")
                         .build())
                 .ocspConfiguration(OcspConfigurationProperty.builder()
                         .enabled(false)
                         .ocspCustomCname("ocspCustomCname")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCertificateAuthority.AccessDescriptionProperty Example:
static interface	CfnCertificateAuthority.AccessMethodProperty Example:
static class	CfnCertificateAuthority.Builder A fluent builder for CfnCertificateAuthority.
static interface	CfnCertificateAuthority.CrlConfigurationProperty Example:
static interface	CfnCertificateAuthority.CsrExtensionsProperty Example:
static interface	CfnCertificateAuthority.EdiPartyNameProperty Example:
static interface	CfnCertificateAuthority.GeneralNameProperty Example:
static interface	CfnCertificateAuthority.KeyUsageProperty Example:
static interface	CfnCertificateAuthority.OcspConfigurationProperty Example:
static interface	CfnCertificateAuthority.OtherNameProperty Example:
static interface	CfnCertificateAuthority.RevocationConfigurationProperty Example:
static interface	CfnCertificateAuthority.SubjectProperty Example:

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
	CfnCertificateAuthority(software.constructs.Construct scope, String id, CfnCertificateAuthorityProps props) Create a new `AWS::ACMPCA::CertificateAuthority`.
protected	CfnCertificateAuthority(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCertificateAuthority(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrCertificateSigningRequest()
protected Map<String,Object>	getCfnProperties()
Object	getCsrExtensions() `AWS::ACMPCA::CertificateAuthority.CsrExtensions`.
String	getKeyAlgorithm() `AWS::ACMPCA::CertificateAuthority.KeyAlgorithm`.
String	getKeyStorageSecurityStandard() `AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard`.
Object	getRevocationConfiguration() `AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.
String	getSigningAlgorithm() `AWS::ACMPCA::CertificateAuthority.SigningAlgorithm`.
Object	getSubject() `AWS::ACMPCA::CertificateAuthority.Subject`.
TagManager	getTags() `AWS::ACMPCA::CertificateAuthority.Tags`.
String	getType() `AWS::ACMPCA::CertificateAuthority.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCsrExtensions(CfnCertificateAuthority.CsrExtensionsProperty value) `AWS::ACMPCA::CertificateAuthority.CsrExtensions`.
void	setCsrExtensions(IResolvable value) `AWS::ACMPCA::CertificateAuthority.CsrExtensions`.
void	setKeyAlgorithm(String value) `AWS::ACMPCA::CertificateAuthority.KeyAlgorithm`.
void	setKeyStorageSecurityStandard(String value) `AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard`.
void	setRevocationConfiguration(CfnCertificateAuthority.RevocationConfigurationProperty value) `AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.
void	setRevocationConfiguration(IResolvable value) `AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.
void	setSigningAlgorithm(String value) `AWS::ACMPCA::CertificateAuthority.SigningAlgorithm`.
void	setSubject(CfnCertificateAuthority.SubjectProperty value) `AWS::ACMPCA::CertificateAuthority.Subject`.
void	setSubject(IResolvable value) `AWS::ACMPCA::CertificateAuthority.Subject`.
void	setType(String value) `AWS::ACMPCA::CertificateAuthority.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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

CfnCertificateAuthority

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

CfnCertificateAuthority

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

CfnCertificateAuthority

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

Create a new `AWS::ACMPCA::CertificateAuthority`.

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.

getAttrArn

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

getAttrCertificateSigningRequest

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCsrExtensions

@Stability(value=Stable)
 @Nullable
public Object getCsrExtensions()

`AWS::ACMPCA::CertificateAuthority.CsrExtensions`.

setCsrExtensions

@Stability(value=Stable)
public void setCsrExtensions(@Nullable
                                                      CfnCertificateAuthority.CsrExtensionsProperty value)

`AWS::ACMPCA::CertificateAuthority.CsrExtensions`.

setCsrExtensions

@Stability(value=Stable)
public void setCsrExtensions(@Nullable
                                                      IResolvable value)

`AWS::ACMPCA::CertificateAuthority.CsrExtensions`.

getKeyAlgorithm

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

`AWS::ACMPCA::CertificateAuthority.KeyAlgorithm`.

setKeyAlgorithm

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

`AWS::ACMPCA::CertificateAuthority.KeyAlgorithm`.

getKeyStorageSecurityStandard

@Stability(value=Stable)
 @Nullable
public String getKeyStorageSecurityStandard()

`AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard`.

setKeyStorageSecurityStandard

@Stability(value=Stable)
public void setKeyStorageSecurityStandard(@Nullable
                                                                   String value)

`AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard`.

getRevocationConfiguration

@Stability(value=Stable)
 @Nullable
public Object getRevocationConfiguration()

`AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.

setRevocationConfiguration

@Stability(value=Stable)
public void setRevocationConfiguration(@Nullable
                                                                CfnCertificateAuthority.RevocationConfigurationProperty value)

`AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.

setRevocationConfiguration

@Stability(value=Stable)
public void setRevocationConfiguration(@Nullable
                                                                IResolvable value)

`AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`.

getSigningAlgorithm

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

`AWS::ACMPCA::CertificateAuthority.SigningAlgorithm`.

setSigningAlgorithm

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

`AWS::ACMPCA::CertificateAuthority.SigningAlgorithm`.

getSubject

@Stability(value=Stable)
 @NotNull
public Object getSubject()

`AWS::ACMPCA::CertificateAuthority.Subject`.

setSubject

@Stability(value=Stable)
public void setSubject(@NotNull
                                                CfnCertificateAuthority.SubjectProperty value)

`AWS::ACMPCA::CertificateAuthority.Subject`.

setSubject

@Stability(value=Stable)
public void setSubject(@NotNull
                                                IResolvable value)

`AWS::ACMPCA::CertificateAuthority.Subject`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ACMPCA::CertificateAuthority.Tags`.

getType

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

`AWS::ACMPCA::CertificateAuthority.Type`.

setType

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

`AWS::ACMPCA::CertificateAuthority.Type`.