Package software.amazon.awscdk.services.transfer

Interface CfnCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:34.399Z")
@Stability(Stable)
public interface CfnCertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCertificate.

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.transfer.*;
 CfnCertificateProps cfnCertificateProps = CfnCertificateProps.builder()
         .certificate("certificate")
         .usage("usage")
         // the properties below are optional
         .activeDate("activeDate")
         .certificateChain("certificateChain")
         .description("description")
         .inactiveDate("inactiveDate")
         .privateKey("privateKey")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCertificateProps.Builder	builder()
default String	getActiveDate()	An optional date that specifies when the certificate becomes active.
String	getCertificate()	The file name for the certificate.
default String	getCertificateChain()	The list of certificates that make up the chain for the certificate.
default String	getDescription()	The name or description that's used to identity the certificate.
default String	getInactiveDate()	An optional date that specifies when the certificate becomes inactive.
default String	getPrivateKey()	The file that contains the private key for the certificate that's being imported.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for certificates.
String	getUsage()	Specifies how this certificate is used.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificate

@Stability(Stable)
@NotNull
String getCertificate()

The file name for the certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificate

getUsage

@Stability(Stable)
@NotNull
String getUsage()

Specifies how this certificate is used. It can be used in the following ways:.

• SIGNING : For signing AS2 messages
• ENCRYPTION : For encrypting AS2 messages
• TLS : For securing AS2 communications sent over HTTPS

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-usage

getActiveDate

@Stability(Stable)
@Nullable
default String getActiveDate()

An optional date that specifies when the certificate becomes active.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-activedate

getCertificateChain

@Stability(Stable)
@Nullable
default String getCertificateChain()

The list of certificates that make up the chain for the certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificatechain

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The name or description that's used to identity the certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-description

getInactiveDate

@Stability(Stable)
@Nullable
default String getInactiveDate()

An optional date that specifies when the certificate becomes inactive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-inactivedate

getPrivateKey

@Stability(Stable)
@Nullable
default String getPrivateKey()

The file that contains the private key for the certificate that's being imported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-privatekey

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key-value pairs that can be used to group and search for certificates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-tags

builder

@Stability(Stable)
static CfnCertificateProps.Builder builder()

Returns:

a CfnCertificateProps.Builder of CfnCertificateProps