Package software.amazon.awscdk.services.pcaconnectorad

Interface CfnTemplate.TemplateV2Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TemplateV2Property.Jsii$Proxy

Enclosing class:

CfnTemplate

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

v2 template schema that uses Legacy Cryptographic 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.*;
 TemplateV2Property templateV2Property = TemplateV2Property.builder()
         .certificateValidity(CertificateValidityProperty.builder()
                 .renewalPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .validityPeriod(ValidityPeriodProperty.builder()
                         .period(123)
                         .periodType("periodType")
                         .build())
                 .build())
         .enrollmentFlags(EnrollmentFlagsV2Property.builder()
                 .enableKeyReuseOnNtTokenKeysetStorageFull(false)
                 .includeSymmetricAlgorithms(false)
                 .noSecurityExtension(false)
                 .removeInvalidCertificateFromPersonalStore(false)
                 .userInteractionRequired(false)
                 .build())
         .extensions(ExtensionsV2Property.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(GeneralFlagsV2Property.builder()
                 .autoEnrollment(false)
                 .machineType(false)
                 .build())
         .privateKeyAttributes(PrivateKeyAttributesV2Property.builder()
                 .keySpec("keySpec")
                 .minimalKeyLength(123)
                 // the properties below are optional
                 .cryptoProviders(List.of("cryptoProviders"))
                 .build())
         .privateKeyFlags(PrivateKeyFlagsV2Property.builder()
                 .clientVersion("clientVersion")
                 // the properties below are optional
                 .exportableKey(false)
                 .strongKeyProtectionRequired(false)
                 .build())
         .subjectNameFlags(SubjectNameFlagsV2Property.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-templatev2.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.TemplateV2Property.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.
Object	getPrivateKeyAttributes()	Private key attributes allow you to specify the minimal key length, key spec, and cryptographic providers for the private key of a certificate for v2 templates.
Object	getPrivateKeyFlags()	Private key flags for v2 templates specify the client compatibility, if the private key can be exported, and if user input is required when using a 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.

Returns union: either IResolvable or CfnTemplate.CertificateValidityProperty

See Also:

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

Returns union: either IResolvable or CfnTemplate.EnrollmentFlagsV2Property

See Also:

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

getExtensions

@Stability(Stable)
@NotNull
Object getExtensions()

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

Returns union: either IResolvable or CfnTemplate.ExtensionsV2Property

See Also:

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

Returns union: either IResolvable or CfnTemplate.GeneralFlagsV2Property

See Also:

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

getPrivateKeyAttributes

@Stability(Stable)
@NotNull
Object getPrivateKeyAttributes()

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

V2 templates allow you to use Legacy Cryptographic Service Providers.

Returns union: either IResolvable or CfnTemplate.PrivateKeyAttributesV2Property

See Also:

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

getPrivateKeyFlags

@Stability(Stable)
@NotNull
Object getPrivateKeyFlags()

Private key flags for v2 templates specify the client compatibility, if the private key can be exported, and if user input is required when using a private key.

Returns union: either IResolvable or CfnTemplate.PrivateKeyFlagsV2Property

See Also:

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

getSubjectNameFlags

@Stability(Stable)
@NotNull
Object getSubjectNameFlags()

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

Returns union: either IResolvable or CfnTemplate.SubjectNameFlagsV2Property

See Also:

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

builder

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

Returns:

a CfnTemplate.TemplateV2Property.Builder of CfnTemplate.TemplateV2Property