Package software.amazon.awscdk.services.pcaconnectorad

Interface CfnTemplate.TemplateV4Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TemplateV4Property.Jsii$Proxy

Enclosing class:

CfnTemplate

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

v4 template schema that can use either Legacy Cryptographic Providers or 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.*;
 TemplateV4Property templateV4Property = TemplateV4Property.builder()
         .certificateValidity(CertificateValidityProperty.builder()
                 .renewalPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .validityPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .build())
         .enrollmentFlags(EnrollmentFlagsV4Property.builder()
                 .enableKeyReuseOnNtTokenKeysetStorageFull(false)
                 .includeSymmetricAlgorithms(false)
                 .noSecurityExtension(false)
                 .removeInvalidCertificateFromPersonalStore(false)
                 .userInteractionRequired(false)
                 .build())
         .extensions(ExtensionsV4Property.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(GeneralFlagsV4Property.builder()
                 .autoEnrollment(false)
                 .machineType(false)
                 .build())
         .privateKeyAttributes(PrivateKeyAttributesV4Property.builder()
                 .keySpec("keySpec")
                 .minimalKeyLength(123)
                 // the properties below are optional
                 .algorithm("algorithm")
                 .cryptoProviders(List.of("cryptoProviders"))
                 .keyUsageProperty(KeyUsagePropertyProperty.builder()
                         .propertyFlags(KeyUsagePropertyFlagsProperty.builder()
                                 .decrypt(false)
                                 .keyAgreement(false)
                                 .sign(false)
                                 .build())
                         .propertyType("propertyType")
                         .build())
                 .build())
         .privateKeyFlags(PrivateKeyFlagsV4Property.builder()
                 .clientVersion("clientVersion")
                 // the properties below are optional
                 .exportableKey(false)
                 .requireAlternateSignatureAlgorithm(false)
                 .requireSameKeyRenewal(false)
                 .strongKeyProtectionRequired(false)
                 .useLegacyProvider(false)
                 .build())
         .subjectNameFlags(SubjectNameFlagsV4Property.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
         .hashAlgorithm("hashAlgorithm")
         .supersededTemplates(List.of("supersededTemplates"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.TemplateV4Property.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 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.
default String	getHashAlgorithm()	Specifies the hash algorithm used to hash the private key.
Object	getPrivateKeyAttributes()	Private key attributes allow you to specify the minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v4 templates.
Object	getPrivateKeyFlags()	Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.
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-templatev4.html#cfn-pcaconnectorad-template-templatev4-certificatevalidity

getEnrollmentFlags

@Stability(Stable)
@NotNull
Object getEnrollmentFlags()

Enrollment flags describe the enrollment settings for certificates 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-templatev4.html#cfn-pcaconnectorad-template-templatev4-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-templatev4.html#cfn-pcaconnectorad-template-templatev4-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-templatev4.html#cfn-pcaconnectorad-template-templatev4-generalflags

getPrivateKeyAttributes

@Stability(Stable)
@NotNull
Object getPrivateKeyAttributes()

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

V4 templates allow you to use either Key Storage Providers or Legacy Cryptographic Service Providers. You specify the cryptography provider category in private key flags.

See Also:

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

getPrivateKeyFlags

@Stability(Stable)
@NotNull
Object getPrivateKeyFlags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-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-templatev4.html#cfn-pcaconnectorad-template-templatev4-subjectnameflags

getHashAlgorithm

@Stability(Stable)
@Nullable
default String getHashAlgorithm()

Specifies the hash algorithm used to hash the private key.

Hash algorithm can only be specified when using Key Storage Providers.

See Also:

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

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-templatev4.html#cfn-pcaconnectorad-template-templatev4-supersededtemplates

builder

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

Returns:

a CfnTemplate.TemplateV4Property.Builder of CfnTemplate.TemplateV4Property