software.amazon.awscdk.services.acmpca

Class CfnCertificate

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.CfnCertificate

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.687Z")
 @Stability(value=Stable)
public class CfnCertificate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ACMPCA::Certificate`.

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.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .certificateAuthorityArn("certificateAuthorityArn")
         .certificateSigningRequest("certificateSigningRequest")
         .signingAlgorithm("signingAlgorithm")
         .validity(ValidityProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         // the properties below are optional
         .apiPassthrough(ApiPassthroughProperty.builder()
                 .extensions(ExtensionsProperty.builder()
                         .certificatePolicies(List.of(PolicyInformationProperty.builder()
                                 .certPolicyId("certPolicyId")
                                 // the properties below are optional
                                 .policyQualifiers(List.of(PolicyQualifierInfoProperty.builder()
                                         .policyQualifierId("policyQualifierId")
                                         .qualifier(QualifierProperty.builder()
                                                 .cpsUri("cpsUri")
                                                 .build())
                                         .build()))
                                 .build()))
                         .extendedKeyUsage(List.of(ExtendedKeyUsageProperty.builder()
                                 .extendedKeyUsageObjectIdentifier("extendedKeyUsageObjectIdentifier")
                                 .extendedKeyUsageType("extendedKeyUsageType")
                                 .build()))
                         .keyUsage(KeyUsageProperty.builder()
                                 .crlSign(false)
                                 .dataEncipherment(false)
                                 .decipherOnly(false)
                                 .digitalSignature(false)
                                 .encipherOnly(false)
                                 .keyAgreement(false)
                                 .keyCertSign(false)
                                 .keyEncipherment(false)
                                 .nonRepudiation(false)
                                 .build())
                         .subjectAlternativeNames(List.of(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()))
                         .build())
                 .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())
                 .build())
         .templateArn("templateArn")
         .validityNotBefore(ValidityProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCertificate.ApiPassthroughProperty Example:
static class	CfnCertificate.Builder A fluent builder for CfnCertificate.
static interface	CfnCertificate.EdiPartyNameProperty Example:
static interface	CfnCertificate.ExtendedKeyUsageProperty Example:
static interface	CfnCertificate.ExtensionsProperty Example:
static interface	CfnCertificate.GeneralNameProperty Example:
static interface	CfnCertificate.KeyUsageProperty Example:
static interface	CfnCertificate.OtherNameProperty Example:
static interface	CfnCertificate.PolicyInformationProperty Example:
static interface	CfnCertificate.PolicyQualifierInfoProperty Example:
static interface	CfnCertificate.QualifierProperty Example:
static interface	CfnCertificate.SubjectProperty Example:
static interface	CfnCertificate.ValidityProperty 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
	CfnCertificate(software.constructs.Construct scope, String id, CfnCertificateProps props) Create a new `AWS::ACMPCA::Certificate`.
protected	CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getApiPassthrough() `AWS::ACMPCA::Certificate.ApiPassthrough`.
String	getAttrArn()
String	getAttrCertificate()
String	getCertificateAuthorityArn() `AWS::ACMPCA::Certificate.CertificateAuthorityArn`.
String	getCertificateSigningRequest() `AWS::ACMPCA::Certificate.CertificateSigningRequest`.
protected Map<String,Object>	getCfnProperties()
String	getSigningAlgorithm() `AWS::ACMPCA::Certificate.SigningAlgorithm`.
String	getTemplateArn() `AWS::ACMPCA::Certificate.TemplateArn`.
Object	getValidity() `AWS::ACMPCA::Certificate.Validity`.
Object	getValidityNotBefore() `AWS::ACMPCA::Certificate.ValidityNotBefore`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiPassthrough(CfnCertificate.ApiPassthroughProperty value) `AWS::ACMPCA::Certificate.ApiPassthrough`.
void	setApiPassthrough(IResolvable value) `AWS::ACMPCA::Certificate.ApiPassthrough`.
void	setCertificateAuthorityArn(String value) `AWS::ACMPCA::Certificate.CertificateAuthorityArn`.
void	setCertificateSigningRequest(String value) `AWS::ACMPCA::Certificate.CertificateSigningRequest`.
void	setSigningAlgorithm(String value) `AWS::ACMPCA::Certificate.SigningAlgorithm`.
void	setTemplateArn(String value) `AWS::ACMPCA::Certificate.TemplateArn`.
void	setValidity(CfnCertificate.ValidityProperty value) `AWS::ACMPCA::Certificate.Validity`.
void	setValidity(IResolvable value) `AWS::ACMPCA::Certificate.Validity`.
void	setValidityNotBefore(CfnCertificate.ValidityProperty value) `AWS::ACMPCA::Certificate.ValidityNotBefore`.
void	setValidityNotBefore(IResolvable value) `AWS::ACMPCA::Certificate.ValidityNotBefore`.

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

CfnCertificate

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

CfnCertificate

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

CfnCertificate

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

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

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.

getApiPassthrough

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

`AWS::ACMPCA::Certificate.ApiPassthrough`.

setApiPassthrough

@Stability(value=Stable)
public void setApiPassthrough(@Nullable
                                                       CfnCertificate.ApiPassthroughProperty value)

`AWS::ACMPCA::Certificate.ApiPassthrough`.

setApiPassthrough

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

`AWS::ACMPCA::Certificate.ApiPassthrough`.

getAttrArn

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

getAttrCertificate

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

getCertificateAuthorityArn

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

`AWS::ACMPCA::Certificate.CertificateAuthorityArn`.

setCertificateAuthorityArn

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

`AWS::ACMPCA::Certificate.CertificateAuthorityArn`.

getCertificateSigningRequest

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

`AWS::ACMPCA::Certificate.CertificateSigningRequest`.

setCertificateSigningRequest

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

`AWS::ACMPCA::Certificate.CertificateSigningRequest`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getSigningAlgorithm

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

`AWS::ACMPCA::Certificate.SigningAlgorithm`.

setSigningAlgorithm

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

`AWS::ACMPCA::Certificate.SigningAlgorithm`.

getTemplateArn

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

`AWS::ACMPCA::Certificate.TemplateArn`.

setTemplateArn

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

`AWS::ACMPCA::Certificate.TemplateArn`.

getValidity

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

`AWS::ACMPCA::Certificate.Validity`.

setValidity

@Stability(value=Stable)
public void setValidity(@NotNull
                                                 CfnCertificate.ValidityProperty value)

`AWS::ACMPCA::Certificate.Validity`.

setValidity

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

`AWS::ACMPCA::Certificate.Validity`.

getValidityNotBefore

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

`AWS::ACMPCA::Certificate.ValidityNotBefore`.

setValidityNotBefore

@Stability(value=Stable)
public void setValidityNotBefore(@Nullable
                                                          CfnCertificate.ValidityProperty value)

`AWS::ACMPCA::Certificate.ValidityNotBefore`.

setValidityNotBefore

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

`AWS::ACMPCA::Certificate.ValidityNotBefore`.