@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.259Z") public class CfnCertificate extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCertificate.Builder
A fluent builder for
CfnCertificate . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCertificate(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActiveDate()
An optional date that specifies when the certificate becomes active.
|
java.lang.String |
getAttrArn()
The unique Amazon Resource Name (ARN) for the certificate.
|
java.lang.String |
getAttrCertificateId()
An array of identifiers for the imported certificates.
|
java.lang.String |
getAttrNotAfterDate()
The final date that the certificate is valid.
|
java.lang.String |
getAttrNotBeforeDate()
The earliest date that the certificate is valid.
|
java.lang.String |
getAttrSerial()
The serial number for the certificate.
|
java.lang.String |
getAttrStatus()
The certificate can be either `ACTIVE` , `PENDING_ROTATION` , or `INACTIVE` .
|
java.lang.String |
getAttrType()
If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY` .
|
java.lang.String |
getCertificate()
The file name for the certificate.
|
java.lang.String |
getCertificateChain()
The list of certificates that make up the chain for the certificate.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
The name or description that's used to identity the certificate.
|
java.lang.String |
getInactiveDate()
An optional date that specifies when the certificate becomes inactive.
|
java.lang.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.
|
java.lang.String |
getUsage()
Specifies whether this certificate is used for signing or encryption.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setActiveDate(java.lang.String value)
An optional date that specifies when the certificate becomes active.
|
void |
setCertificate(java.lang.String value)
The file name for the certificate.
|
void |
setCertificateChain(java.lang.String value)
The list of certificates that make up the chain for the certificate.
|
void |
setDescription(java.lang.String value)
The name or description that's used to identity the certificate.
|
void |
setInactiveDate(java.lang.String value)
An optional date that specifies when the certificate becomes inactive.
|
void |
setPrivateKey(java.lang.String value)
The file that contains the private key for the certificate that's being imported.
|
void |
setUsage(java.lang.String value)
Specifies whether this certificate is used for signing or encryption.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCertificate(Construct scope, java.lang.String id, CfnCertificateProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrCertificateId()
You use this identifier for working with profiles and partner profiles.
public java.lang.String getAttrNotAfterDate()
public java.lang.String getAttrNotBeforeDate()
public java.lang.String getAttrSerial()
public java.lang.String getAttrStatus()
PENDING_ROTATION
means that this certificate will replace the current certificate when it expires.
public java.lang.String getAttrType()
If there is no private key, the type is CERTIFICATE
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getCertificate()
public void setCertificate(java.lang.String value)
public java.lang.String getUsage()
public void setUsage(java.lang.String value)
public java.lang.String getActiveDate()
public void setActiveDate(java.lang.String value)
public java.lang.String getCertificateChain()
public void setCertificateChain(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getInactiveDate()
public void setInactiveDate(java.lang.String value)
public java.lang.String getPrivateKey()
public void setPrivateKey(java.lang.String value)