Skip to content
v2.277.0

TemplateV3Property Struct ​

v3 template schema that uses Key Storage Providers.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pcaconnectorad as pcaconnectorad } from 'aws-cdk-lib';
const templateV3Property: pcaconnectorad.CfnTemplate.TemplateV3Property = {
  certificateValidity: {
    renewalPeriod: {
      period: 123,
      periodType: 'periodType',
    },
    validityPeriod: {
      period: 123,
      periodType: 'periodType',
    },
  },
  enrollmentFlags: {
    enableKeyReuseOnNtTokenKeysetStorageFull: false,
    includeSymmetricAlgorithms: false,
    noSecurityExtension: false,
    removeInvalidCertificateFromPersonalStore: false,
    userInteractionRequired: false,
  },
  extensions: {
    keyUsage: {
      usageFlags: {
        dataEncipherment: false,
        digitalSignature: false,
        keyAgreement: false,
        keyEncipherment: false,
        nonRepudiation: false,
      },

      // the properties below are optional
      critical: false,
    },

    // the properties below are optional
    applicationPolicies: {
      policies: [{
        policyObjectIdentifier: 'policyObjectIdentifier',
        policyType: 'policyType',
      }],

      // the properties below are optional
      critical: false,
    },
  },
  generalFlags: {
    autoEnrollment: false,
    machineType: false,
  },
  hashAlgorithm: 'hashAlgorithm',
  privateKeyAttributes: {
    algorithm: 'algorithm',
    keySpec: 'keySpec',
    keyUsageProperty: {
      propertyFlags: {
        decrypt: false,
        keyAgreement: false,
        sign: false,
      },
      propertyType: 'propertyType',
    },
    minimalKeyLength: 123,

    // the properties below are optional
    cryptoProviders: ['cryptoProviders'],
  },
  privateKeyFlags: {
    clientVersion: 'clientVersion',

    // the properties below are optional
    exportableKey: false,
    requireAlternateSignatureAlgorithm: false,
    strongKeyProtectionRequired: false,
  },
  subjectNameFlags: {
    requireCommonName: false,
    requireDirectoryPath: false,
    requireDnsAsCn: false,
    requireEmail: false,
    sanRequireDirectoryGuid: false,
    sanRequireDns: false,
    sanRequireDomainDns: false,
    sanRequireEmail: false,
    sanRequireSpn: false,
    sanRequireUpn: false,
  },

  // the properties below are optional
  supersededTemplates: ['supersededTemplates'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pcaconnectorad as pcaconnectorad

template_v3_property = pcaconnectorad.CfnTemplate.TemplateV3Property(
    certificate_validity=pcaconnectorad.CfnTemplate.CertificateValidityProperty(
        renewal_period=pcaconnectorad.CfnTemplate.ValidityPeriodProperty(
            period=123,
            period_type="periodType"
        ),
        validity_period=pcaconnectorad.CfnTemplate.ValidityPeriodProperty(
            period=123,
            period_type="periodType"
        )
    ),
    enrollment_flags=pcaconnectorad.CfnTemplate.EnrollmentFlagsV3Property(
        enable_key_reuse_on_nt_token_keyset_storage_full=False,
        include_symmetric_algorithms=False,
        no_security_extension=False,
        remove_invalid_certificate_from_personal_store=False,
        user_interaction_required=False
    ),
    extensions=pcaconnectorad.CfnTemplate.ExtensionsV3Property(
        key_usage=pcaconnectorad.CfnTemplate.KeyUsageProperty(
            usage_flags=pcaconnectorad.CfnTemplate.KeyUsageFlagsProperty(
                data_encipherment=False,
                digital_signature=False,
                key_agreement=False,
                key_encipherment=False,
                non_repudiation=False
            ),

            # the properties below are optional
            critical=False
        ),

        # the properties below are optional
        application_policies=pcaconnectorad.CfnTemplate.ApplicationPoliciesProperty(
            policies=[pcaconnectorad.CfnTemplate.ApplicationPolicyProperty(
                policy_object_identifier="policyObjectIdentifier",
                policy_type="policyType"
            )],

            # the properties below are optional
            critical=False
        )
    ),
    general_flags=pcaconnectorad.CfnTemplate.GeneralFlagsV3Property(
        auto_enrollment=False,
        machine_type=False
    ),
    hash_algorithm="hashAlgorithm",
    private_key_attributes=pcaconnectorad.CfnTemplate.PrivateKeyAttributesV3Property(
        algorithm="algorithm",
        key_spec="keySpec",
        key_usage_property=pcaconnectorad.CfnTemplate.KeyUsagePropertyProperty(
            property_flags=pcaconnectorad.CfnTemplate.KeyUsagePropertyFlagsProperty(
                decrypt=False,
                key_agreement=False,
                sign=False
            ),
            property_type="propertyType"
        ),
        minimal_key_length=123,

        # the properties below are optional
        crypto_providers=["cryptoProviders"]
    ),
    private_key_flags=pcaconnectorad.CfnTemplate.PrivateKeyFlagsV3Property(
        client_version="clientVersion",

        # the properties below are optional
        exportable_key=False,
        require_alternate_signature_algorithm=False,
        strong_key_protection_required=False
    ),
    subject_name_flags=pcaconnectorad.CfnTemplate.SubjectNameFlagsV3Property(
        require_common_name=False,
        require_directory_path=False,
        require_dns_as_cn=False,
        require_email=False,
        san_require_directory_guid=False,
        san_require_dns=False,
        san_require_domain_dns=False,
        san_require_email=False,
        san_require_spn=False,
        san_require_upn=False
    ),

    # the properties below are optional
    superseded_templates=["supersededTemplates"]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.PCAConnectorAD;

var templateV3Property = new TemplateV3Property {
    CertificateValidity = new CertificateValidityProperty {
        RenewalPeriod = new ValidityPeriodProperty {
            Period = 123,
            PeriodType = "periodType"
        },
        ValidityPeriod = new ValidityPeriodProperty {
            Period = 123,
            PeriodType = "periodType"
        }
    },
    EnrollmentFlags = new EnrollmentFlagsV3Property {
        EnableKeyReuseOnNtTokenKeysetStorageFull = false,
        IncludeSymmetricAlgorithms = false,
        NoSecurityExtension = false,
        RemoveInvalidCertificateFromPersonalStore = false,
        UserInteractionRequired = false
    },
    Extensions = new ExtensionsV3Property {
        KeyUsage = new KeyUsageProperty {
            UsageFlags = new KeyUsageFlagsProperty {
                DataEncipherment = false,
                DigitalSignature = false,
                KeyAgreement = false,
                KeyEncipherment = false,
                NonRepudiation = false
            },

            // the properties below are optional
            Critical = false
        },

        // the properties below are optional
        ApplicationPolicies = new ApplicationPoliciesProperty {
            Policies = new [] { new ApplicationPolicyProperty {
                PolicyObjectIdentifier = "policyObjectIdentifier",
                PolicyType = "policyType"
            } },

            // the properties below are optional
            Critical = false
        }
    },
    GeneralFlags = new GeneralFlagsV3Property {
        AutoEnrollment = false,
        MachineType = false
    },
    HashAlgorithm = "hashAlgorithm",
    PrivateKeyAttributes = new PrivateKeyAttributesV3Property {
        Algorithm = "algorithm",
        KeySpec = "keySpec",
        KeyUsageProperty = new KeyUsagePropertyProperty {
            PropertyFlags = new KeyUsagePropertyFlagsProperty {
                Decrypt = false,
                KeyAgreement = false,
                Sign = false
            },
            PropertyType = "propertyType"
        },
        MinimalKeyLength = 123,

        // the properties below are optional
        CryptoProviders = new [] { "cryptoProviders" }
    },
    PrivateKeyFlags = new PrivateKeyFlagsV3Property {
        ClientVersion = "clientVersion",

        // the properties below are optional
        ExportableKey = false,
        RequireAlternateSignatureAlgorithm = false,
        StrongKeyProtectionRequired = false
    },
    SubjectNameFlags = new SubjectNameFlagsV3Property {
        RequireCommonName = false,
        RequireDirectoryPath = false,
        RequireDnsAsCn = false,
        RequireEmail = false,
        SanRequireDirectoryGuid = false,
        SanRequireDns = false,
        SanRequireDomainDns = false,
        SanRequireEmail = false,
        SanRequireSpn = false,
        SanRequireUpn = false
    },

    // the properties below are optional
    SupersededTemplates = new [] { "supersededTemplates" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

templateV3Property := &TemplateV3Property{
	CertificateValidity: &CertificateValidityProperty{
		RenewalPeriod: &ValidityPeriodProperty{
			Period: jsii.Number(123),
			PeriodType: jsii.String("periodType"),
		},
		ValidityPeriod: &ValidityPeriodProperty{
			Period: jsii.Number(123),
			PeriodType: jsii.String("periodType"),
		},
	},
	EnrollmentFlags: &EnrollmentFlagsV3Property{
		EnableKeyReuseOnNtTokenKeysetStorageFull: jsii.Boolean(false),
		IncludeSymmetricAlgorithms: jsii.Boolean(false),
		NoSecurityExtension: jsii.Boolean(false),
		RemoveInvalidCertificateFromPersonalStore: jsii.Boolean(false),
		UserInteractionRequired: jsii.Boolean(false),
	},
	Extensions: &ExtensionsV3Property{
		KeyUsage: &KeyUsageProperty{
			UsageFlags: &KeyUsageFlagsProperty{
				DataEncipherment: jsii.Boolean(false),
				DigitalSignature: jsii.Boolean(false),
				KeyAgreement: jsii.Boolean(false),
				KeyEncipherment: jsii.Boolean(false),
				NonRepudiation: jsii.Boolean(false),
			},

			// the properties below are optional
			Critical: jsii.Boolean(false),
		},

		// the properties below are optional
		ApplicationPolicies: &ApplicationPoliciesProperty{
			Policies: []interface{}{
				&ApplicationPolicyProperty{
					PolicyObjectIdentifier: jsii.String("policyObjectIdentifier"),
					PolicyType: jsii.String("policyType"),
				},
			},

			// the properties below are optional
			Critical: jsii.Boolean(false),
		},
	},
	GeneralFlags: &GeneralFlagsV3Property{
		AutoEnrollment: jsii.Boolean(false),
		MachineType: jsii.Boolean(false),
	},
	HashAlgorithm: jsii.String("hashAlgorithm"),
	PrivateKeyAttributes: &PrivateKeyAttributesV3Property{
		Algorithm: jsii.String("algorithm"),
		KeySpec: jsii.String("keySpec"),
		KeyUsageProperty: &KeyUsagePropertyProperty{
			PropertyFlags: &KeyUsagePropertyFlagsProperty{
				Decrypt: jsii.Boolean(false),
				KeyAgreement: jsii.Boolean(false),
				Sign: jsii.Boolean(false),
			},
			PropertyType: jsii.String("propertyType"),
		},
		MinimalKeyLength: jsii.Number(123),

		// the properties below are optional
		CryptoProviders: []*string{
			jsii.String("cryptoProviders"),
		},
	},
	PrivateKeyFlags: &PrivateKeyFlagsV3Property{
		ClientVersion: jsii.String("clientVersion"),

		// the properties below are optional
		ExportableKey: jsii.Boolean(false),
		RequireAlternateSignatureAlgorithm: jsii.Boolean(false),
		StrongKeyProtectionRequired: jsii.Boolean(false),
	},
	SubjectNameFlags: &SubjectNameFlagsV3Property{
		RequireCommonName: jsii.Boolean(false),
		RequireDirectoryPath: jsii.Boolean(false),
		RequireDnsAsCn: jsii.Boolean(false),
		RequireEmail: jsii.Boolean(false),
		SanRequireDirectoryGuid: jsii.Boolean(false),
		SanRequireDns: jsii.Boolean(false),
		SanRequireDomainDns: jsii.Boolean(false),
		SanRequireEmail: jsii.Boolean(false),
		SanRequireSpn: jsii.Boolean(false),
		SanRequireUpn: jsii.Boolean(false),
	},

	// the properties below are optional
	SupersededTemplates: []*string{
		jsii.String("supersededTemplates"),
	},
}

Properties ​

certificateValidityIResolvable | CfnTemplate.CertificateValidityPropertycertificate_validitytyping.Union[IResolvable, CertificateValidityProperty]certificateValidityIResolvableCertificateValidityIResolvableCertificateValidityinterface{}required#
Certificate validity describes the validity and renewal periods of a certificate.
enrollmentFlagsIResolvable | CfnTemplate.EnrollmentFlagsV3Propertyenrollment_flagstyping.Union[IResolvable, EnrollmentFlagsV3Property]enrollmentFlagsIResolvableEnrollmentFlagsIResolvableEnrollmentFlagsinterface{}required#
Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.
extensionsIResolvable | CfnTemplate.ExtensionsV3Propertyextensionstyping.Union[IResolvable, ExtensionsV3Property]extensionsIResolvableExtensionsIResolvableExtensionsinterface{}required#
Extensions describe the key usage extensions and application policies for a template.
generalFlagsIResolvable | CfnTemplate.GeneralFlagsV3Propertygeneral_flagstyping.Union[IResolvable, GeneralFlagsV3Property]generalFlagsIResolvableGeneralFlagsIResolvableGeneralFlagsinterface{}required#
General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.
hashAlgorithmstringhash_algorithmstrhashAlgorithmStringHashAlgorithmstringHashAlgorithm*stringrequired#
Specifies the hash algorithm used to hash the private key.
privateKeyAttributesIResolvable | CfnTemplate.PrivateKeyAttributesV3Propertyprivate_key_attributestyping.Union[IResolvable, PrivateKeyAttributesV3Property]privateKeyAttributesIResolvablePrivateKeyAttributesIResolvablePrivateKeyAttributesinterface{}required#
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.

privateKeyFlagsIResolvable | CfnTemplate.PrivateKeyFlagsV3Propertyprivate_key_flagstyping.Union[IResolvable, PrivateKeyFlagsV3Property]privateKeyFlagsIResolvablePrivateKeyFlagsIResolvablePrivateKeyFlagsinterface{}required#
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.
subjectNameFlagsIResolvable | CfnTemplate.SubjectNameFlagsV3Propertysubject_name_flagstyping.Union[IResolvable, SubjectNameFlagsV3Property]subjectNameFlagsIResolvableSubjectNameFlagsIResolvableSubjectNameFlagsinterface{}required#
Subject name flags describe the subject name and subject alternate name that is included in a certificate.
supersededTemplatesoptionalstring[]superseded_templatesoptionaltyping.List[str]supersededTemplatesoptionalList<String>SupersededTemplatesoptionalstring[]SupersededTemplatesoptional*[]*string#
List of templates in Active Directory that are superseded by this template.