Package software.amazon.awscdk.cfnpropertymixins.services.pcaconnectorad

Interface CfnTemplatePropsMixin.TemplateV3Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplatePropsMixin.TemplateV3Property.Jsii$Proxy

Enclosing class:

CfnTemplatePropsMixin

@Stability(Stable)
public static interface CfnTemplatePropsMixin.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.cfnpropertymixins.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()
                 .applicationPolicies(ApplicationPoliciesProperty.builder()
                         .critical(false)
                         .policies(List.of(ApplicationPolicyProperty.builder()
                                 .policyObjectIdentifier("policyObjectIdentifier")
                                 .policyType("policyType")
                                 .build()))
                         .build())
                 .keyUsage(KeyUsageProperty.builder()
                         .critical(false)
                         .usageFlags(KeyUsageFlagsProperty.builder()
                                 .dataEncipherment(false)
                                 .digitalSignature(false)
                                 .keyAgreement(false)
                                 .keyEncipherment(false)
                                 .nonRepudiation(false)
                                 .build())
                         .build())
                 .build())
         .generalFlags(GeneralFlagsV3Property.builder()
                 .autoEnrollment(false)
                 .machineType(false)
                 .build())
         .hashAlgorithm("hashAlgorithm")
         .privateKeyAttributes(PrivateKeyAttributesV3Property.builder()
                 .algorithm("algorithm")
                 .cryptoProviders(List.of("cryptoProviders"))
                 .keySpec("keySpec")
                 .keyUsageProperty(KeyUsagePropertyProperty.builder()
                         .propertyFlags(KeyUsagePropertyFlagsProperty.builder()
                                 .decrypt(false)
                                 .keyAgreement(false)
                                 .sign(false)
                                 .build())
                         .propertyType("propertyType")
                         .build())
                 .minimalKeyLength(123)
                 .build())
         .privateKeyFlags(PrivateKeyFlagsV3Property.builder()
                 .clientVersion("clientVersion")
                 .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())
         .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	CfnTemplatePropsMixin.TemplateV3Property.Builder	A builder for CfnTemplatePropsMixin.TemplateV3Property
static final class	CfnTemplatePropsMixin.TemplateV3Property.Jsii$Proxy	An implementation for CfnTemplatePropsMixin.TemplateV3Property

Method Summary

Modifier and Type	Method	Description
static CfnTemplatePropsMixin.TemplateV3Property.Builder	builder()
default Object	getCertificateValidity()	Certificate validity describes the validity and renewal periods of a certificate.
default Object	getEnrollmentFlags()	Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.
default Object	getExtensions()	Extensions describe the key usage extensions and application policies for a template.
default 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.
default 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.
default 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.
default 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)
@Nullable
default Object getCertificateValidity()

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

Returns union: either IResolvable or CfnTemplatePropsMixin.CertificateValidityProperty

See Also:

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

getEnrollmentFlags

@Stability(Stable)
@Nullable
default 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 CfnTemplatePropsMixin.EnrollmentFlagsV3Property

See Also:

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

getExtensions

@Stability(Stable)
@Nullable
default Object getExtensions()

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

Returns union: either IResolvable or CfnTemplatePropsMixin.ExtensionsV3Property

See Also:

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

getGeneralFlags

@Stability(Stable)
@Nullable
default 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 CfnTemplatePropsMixin.GeneralFlagsV3Property

See Also:

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

getHashAlgorithm

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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.

Returns union: either IResolvable or CfnTemplatePropsMixin.PrivateKeyAttributesV3Property

See Also:

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

getPrivateKeyFlags

@Stability(Stable)
@Nullable
default 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.

Returns union: either IResolvable or CfnTemplatePropsMixin.PrivateKeyFlagsV3Property

See Also:

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

getSubjectNameFlags

@Stability(Stable)
@Nullable
default Object getSubjectNameFlags()

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

Returns union: either IResolvable or CfnTemplatePropsMixin.SubjectNameFlagsV3Property

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 CfnTemplatePropsMixin.TemplateV3Property.Builder builder()

Returns:

a CfnTemplatePropsMixin.TemplateV3Property.Builder of CfnTemplatePropsMixin.TemplateV3Property