Package software.amazon.awscdk.services.pcaconnectorad

Interface CfnTemplate.PrivateKeyFlagsV4Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.PrivateKeyFlagsV4Property.Jsii$Proxy

Enclosing class:

CfnTemplate

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

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.

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.*;
 PrivateKeyFlagsV4Property privateKeyFlagsV4Property = PrivateKeyFlagsV4Property.builder()
         .clientVersion("clientVersion")
         // the properties below are optional
         .exportableKey(false)
         .requireAlternateSignatureAlgorithm(false)
         .requireSameKeyRenewal(false)
         .strongKeyProtectionRequired(false)
         .useLegacyProvider(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.PrivateKeyFlagsV4Property.Builder	builder()
String	getClientVersion()	Defines the minimum client compatibility.
default Object	getExportableKey()	Allows the private key to be exported.
default Object	getRequireAlternateSignatureAlgorithm()	Requires the PKCS #1 v2.1 signature format for certificates.
default Object	getRequireSameKeyRenewal()	Renew certificate using the same private key.
default Object	getStrongKeyProtectionRequired()	Require user input when using the private key for enrollment.
default Object	getUseLegacyProvider()	Specifies the cryptographic service provider category used to generate private keys.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientVersion

@Stability(Stable)
@NotNull
String getClientVersion()

Defines the minimum client compatibility.

See Also:

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

getExportableKey

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

Allows the private key to be exported.

Returns union: either Boolean or IResolvable

See Also:

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

getRequireAlternateSignatureAlgorithm

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

Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your CA, objects, and applications can accept this signature format.

Returns union: either Boolean or IResolvable

See Also:

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

getRequireSameKeyRenewal

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

Renew certificate using the same private key.

Returns union: either Boolean or IResolvable

See Also:

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

getStrongKeyProtectionRequired

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

Require user input when using the private key for enrollment.

Returns union: either Boolean or IResolvable

See Also:

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

getUseLegacyProvider

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

Specifies the cryptographic service provider category used to generate private keys.

Set to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage Providers.

Returns union: either Boolean or IResolvable

See Also:

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

builder

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

Returns:

a CfnTemplate.PrivateKeyFlagsV4Property.Builder of CfnTemplate.PrivateKeyFlagsV4Property