Package software.amazon.awscdk.services.pcaconnectorad

Interface CfnTemplate.TemplateV3Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TemplateV3Property.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.TemplateV3Property
extends software.amazon.jsii.JsiiSerializable

v3 template schema that uses Key Storage Providers.

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.pcaconnectorad.*;
 TemplateV3Property templateV3Property = TemplateV3Property.builder()
         .certificateValidity(CertificateValidityProperty.builder()
                 .renewalPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .validityPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .build())
         .enrollmentFlags(EnrollmentFlagsV3Property.builder()
                 .enableKeyReuseOnNtTokenKeysetStorageFull(false)
                 .includeSymmetricAlgorithms(false)
                 .noSecurityExtension(false)
                 .removeInvalidCertificateFromPersonalStore(false)
                 .userInteractionRequired(false)
                 .build())
         .extensions(ExtensionsV3Property.builder()
                 .keyUsage(KeyUsageProperty.builder()
                         .usageFlags(KeyUsageFlagsProperty.builder()
                                 .dataEncipherment(false)
                                 .digitalSignature(false)
                                 .keyAgreement(false)
                                 .keyEncipherment(false)
                                 .nonRepudiation(false)
                                 .build())
                         // the properties below are optional
                         .critical(false)
                         .build())
                 // the properties below are optional
                 .applicationPolicies(ApplicationPoliciesProperty.builder()
                         .policies(List.of(ApplicationPolicyProperty.builder()
                                 .policyObjectIdentifier("policyObjectIdentifier")
                                 .policyType("policyType")
                                 .build()))
                         // the properties below are optional
                         .critical(false)
                         .build())
                 .build())
         .generalFlags(GeneralFlagsV3Property.builder()
                 .autoEnrollment(false)
                 .machineType(false)
                 .build())
         .hashAlgorithm("hashAlgorithm")
         .privateKeyAttributes(PrivateKeyAttributesV3Property.builder()
                 .algorithm("algorithm")
                 .keySpec("keySpec")
                 .keyUsageProperty(KeyUsagePropertyProperty.builder()
                         .propertyFlags(KeyUsagePropertyFlagsProperty.builder()
                                 .decrypt(false)
                                 .keyAgreement(false)
                                 .sign(false)
                                 .build())
                         .propertyType("propertyType")
                         .build())
                 .minimalKeyLength(123)
                 // the properties below are optional
                 .cryptoProviders(List.of("cryptoProviders"))
                 .build())
         .privateKeyFlags(PrivateKeyFlagsV3Property.builder()
                 .clientVersion("clientVersion")
                 // the properties below are optional
                 .exportableKey(false)
                 .requireAlternateSignatureAlgorithm(false)
                 .strongKeyProtectionRequired(false)
                 .build())
         .subjectNameFlags(SubjectNameFlagsV3Property.builder()
                 .requireCommonName(false)
                 .requireDirectoryPath(false)
                 .requireDnsAsCn(false)
                 .requireEmail(false)
                 .sanRequireDirectoryGuid(false)
                 .sanRequireDns(false)
                 .sanRequireDomainDns(false)
                 .sanRequireEmail(false)
                 .sanRequireSpn(false)
                 .sanRequireUpn(false)
                 .build())
         // the properties below are optional
         .supersededTemplates(List.of("supersededTemplates"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.TemplateV3Property.Builder	A builder for CfnTemplate.TemplateV3Property
static final class	CfnTemplate.TemplateV3Property.Jsii$Proxy	An implementation for CfnTemplate.TemplateV3Property

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.TemplateV3Property.Builder	builder()
Object	getCertificateValidity()	Certificate validity describes the validity and renewal periods of a certificate.
Object	getEnrollmentFlags()	Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.
Object	getExtensions()	Extensions describe the key usage extensions and application policies for a template.
Object	getGeneralFlags()	General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.
String	getHashAlgorithm()	Specifies the hash algorithm used to hash the private key.
Object	getPrivateKeyAttributes()	Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates.
Object	getPrivateKeyFlags()	Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.
Object	getSubjectNameFlags()	Subject name flags describe the subject name and subject alternate name that is included in a certificate.
default List<String>	getSupersededTemplates()	List of templates in Active Directory that are superseded by this template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateValidity

@Stability(Stable)
@NotNull
Object getCertificateValidity()

Certificate validity describes the validity and renewal periods of a certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-certificatevalidity

getEnrollmentFlags

@Stability(Stable)
@NotNull
Object getEnrollmentFlags()

Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-enrollmentflags

getExtensions

@Stability(Stable)
@NotNull
Object getExtensions()

Extensions describe the key usage extensions and application policies for a template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-extensions

getGeneralFlags

@Stability(Stable)
@NotNull
Object getGeneralFlags()

General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-generalflags

getHashAlgorithm

@Stability(Stable)
@NotNull
String getHashAlgorithm()

Specifies the hash algorithm used to hash the private key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-hashalgorithm

getPrivateKeyAttributes

@Stability(Stable)
@NotNull
Object getPrivateKeyAttributes()

Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates.

V3 templates allow you to use Key Storage Providers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-privatekeyattributes

getPrivateKeyFlags

@Stability(Stable)
@NotNull
Object getPrivateKeyFlags()

Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-privatekeyflags

getSubjectNameFlags

@Stability(Stable)
@NotNull
Object getSubjectNameFlags()

Subject name flags describe the subject name and subject alternate name that is included in a certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-subjectnameflags

getSupersededTemplates

@Stability(Stable)
@Nullable
default List<String> getSupersededTemplates()

List of templates in Active Directory that are superseded by this template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-supersededtemplates

builder

@Stability(Stable)
static CfnTemplate.TemplateV3Property.Builder builder()

Returns:

a CfnTemplate.TemplateV3Property.Builder of CfnTemplate.TemplateV3Property