Package software.amazon.awscdk.services.pcaconnectorad

Interface CfnTemplate.PrivateKeyFlagsV3Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.PrivateKeyFlagsV3Property.Jsii$Proxy

Enclosing class:

CfnTemplate

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

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.

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.PrivateKeyFlagsV3Property.Builder	builder()
String	getClientVersion()	Defines the minimum client compatibility.
default Object	getExportableKey()	Allows the private key to be exported.
default Object	getRequireAlternateSignatureAlgorithm()	Reguires the PKCS #1 v2.1 signature format for certificates.
default Object	getStrongKeyProtectionRequired()	Requirer user input when using the private key for enrollment.

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-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-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-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-exportablekey

getRequireAlternateSignatureAlgorithm

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

Reguires 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-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-requirealternatesignaturealgorithm

getStrongKeyProtectionRequired

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

Requirer 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-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-strongkeyprotectionrequired

builder

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

Returns:

a CfnTemplate.PrivateKeyFlagsV3Property.Builder of CfnTemplate.PrivateKeyFlagsV3Property