software.amazon.awscdk.services.transfer

Class CfnCertificate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.transfer.CfnCertificate

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:50.577Z")
 @Stability(value=Stable)
public class CfnCertificate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::Certificate`.

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

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.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCertificate.Builder A fluent builder for CfnCertificate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCertificate(Construct scope, String id, CfnCertificateProps props) Create a new `AWS::Transfer::Certificate`.
protected	CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getActiveDate() An optional date that specifies when the certificate becomes active.
String	getAttrArn() The unique Amazon Resource Name (ARN) for the certificate.
String	getAttrCertificateId() An array of identifiers for the imported certificates.
String	getAttrNotAfterDate() The final date that the certificate is valid.
String	getAttrNotBeforeDate() The earliest date that the certificate is valid.
String	getAttrSerial() The serial number for the certificate.
String	getAttrStatus() The certificate can be either `ACTIVE` , `PENDING_ROTATION` , or `INACTIVE` .
String	getAttrType() If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY` .
String	getCertificate() The file name for the certificate.
String	getCertificateChain() The list of certificates that make up the chain for the certificate.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The name or description that's used to identity the certificate.
String	getInactiveDate() An optional date that specifies when the certificate becomes inactive.
String	getPrivateKey() The file that contains the private key for the certificate that's being imported.
TagManager	getTags() Key-value pairs that can be used to group and search for certificates.
String	getUsage() Specifies whether this certificate is used for signing or encryption.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActiveDate(String value) An optional date that specifies when the certificate becomes active.
void	setCertificate(String value) The file name for the certificate.
void	setCertificateChain(String value) The list of certificates that make up the chain for the certificate.
void	setDescription(String value) The name or description that's used to identity the certificate.
void	setInactiveDate(String value) An optional date that specifies when the certificate becomes inactive.
void	setPrivateKey(String value) The file that contains the private key for the certificate that's being imported.
void	setUsage(String value) Specifies whether this certificate is used for signing or encryption.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCertificate

protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

CfnCertificate

protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCertificate

@Stability(value=Stable)
public CfnCertificate(@NotNull
                                               Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnCertificateProps props)

Create a new `AWS::Transfer::Certificate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The unique Amazon Resource Name (ARN) for the certificate.

getAttrCertificateId

@Stability(value=Stable)
 @NotNull
public String getAttrCertificateId()

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.

getAttrNotAfterDate

@Stability(value=Stable)
 @NotNull
public String getAttrNotAfterDate()

The final date that the certificate is valid.

getAttrNotBeforeDate

@Stability(value=Stable)
 @NotNull
public String getAttrNotBeforeDate()

The earliest date that the certificate is valid.

getAttrSerial

@Stability(value=Stable)
 @NotNull
public String getAttrSerial()

The serial number for the certificate.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The certificate can be either `ACTIVE` , `PENDING_ROTATION` , or `INACTIVE` .

PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

getAttrType

@Stability(value=Stable)
 @NotNull
public String getAttrType()

If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY` .

If there is no private key, the type is CERTIFICATE .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getCertificate

@Stability(value=Stable)
 @NotNull
public String getCertificate()

The file name for the certificate.

setCertificate

@Stability(value=Stable)
public void setCertificate(@NotNull
                                                    String value)

The file name for the certificate.

getUsage

@Stability(value=Stable)
 @NotNull
public String getUsage()

Specifies whether this certificate is used for signing or encryption.

setUsage

@Stability(value=Stable)
public void setUsage(@NotNull
                                              String value)

Specifies whether this certificate is used for signing or encryption.

getActiveDate

@Stability(value=Stable)
 @Nullable
public String getActiveDate()

An optional date that specifies when the certificate becomes active.

setActiveDate

@Stability(value=Stable)
public void setActiveDate(@Nullable
                                                   String value)

An optional date that specifies when the certificate becomes active.

getCertificateChain

@Stability(value=Stable)
 @Nullable
public String getCertificateChain()

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

setCertificateChain

@Stability(value=Stable)
public void setCertificateChain(@Nullable
                                                         String value)

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getInactiveDate

@Stability(value=Stable)
 @Nullable
public String getInactiveDate()

An optional date that specifies when the certificate becomes inactive.

setInactiveDate

@Stability(value=Stable)
public void setInactiveDate(@Nullable
                                                     String value)

An optional date that specifies when the certificate becomes inactive.

getPrivateKey

@Stability(value=Stable)
 @Nullable
public String getPrivateKey()

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

setPrivateKey

@Stability(value=Stable)
public void setPrivateKey(@Nullable
                                                   String value)

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