Class: AWSCDK::Transfer::CfnCertificate

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSTransfer::ICertificateRef
Defined in:
transfer/cfn_certificate.rb

Overview

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

You can import both the certificate and its chain in the Certificate parameter.

After importing a certificate, AWS Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace.

It can take up to a full day after importing a certificate for Transfer Family to emit the DaysUntilExpiry metric to your account. > If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

  • Units: Count (days)
  • Dimensions: CertificateId (always present), Description (if provided during certificate import)
  • Statistics: Minimum, Maximum, Average
  • Frequency: Published daily

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCertificate

Create a new AWS::Transfer::Certificate.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Transfer::CfnCertificateProps) —

    Resource properties.



33
34
35
36
37
38
39
 
# File 'transfer/cfn_certificate.rb', line 33

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Transfer::CfnCertificateProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuQ2VydGlmaWNhdGVQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_certificate(resource) ⇒ String

Parameters:

Returns:

  • (String) 


100
101
102
103
 
# File 'transfer/cfn_certificate.rb', line 100

def self.arn_for_certificate(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190cmFuc2Zlci5JQ2VydGlmaWNhdGVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnCertificate", "arnForCertificate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


233
234
235
 
# File 'transfer/cfn_certificate.rb', line 233

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_transfer.CfnCertificate", "CFN_RESOURCE_TYPE_NAME")
end

.from_certificate_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSTransfer::ICertificateRef

Creates a new ICertificateRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



111
112
113
114
115
116
 
# File 'transfer/cfn_certificate.rb', line 111

def self.from_certificate_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnCertificate", "fromCertificateArn", [scope, id, arn])
end

.from_certificate_id(scope, id, certificate_id) ⇒ AWSCDK::Interfaces::AWSTransfer::ICertificateRef

Creates a new ICertificateRef from a certificateId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • certificate_id (String)

Returns:



124
125
126
127
128
129
 
# File 'transfer/cfn_certificate.rb', line 124

def self.from_certificate_id(scope, id, certificate_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(certificate_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnCertificate", "fromCertificateId", [scope, id, certificate_id])
end

.is_cfn_certificate(x) ⇒ Boolean

Checks whether the given object is a CfnCertificate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


135
136
137
138
 
# File 'transfer/cfn_certificate.rb', line 135

def self.is_cfn_certificate(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnCertificate", "isCfnCertificate", [x])
end

.jsii_overridable_methods ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'transfer/cfn_certificate.rb', line 41

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_certificate_id => { kind: :property, name: "attrCertificateId", is_optional: false },
    :attr_not_after_date => { kind: :property, name: "attrNotAfterDate", is_optional: false },
    :attr_not_before_date => { kind: :property, name: "attrNotBeforeDate", is_optional: false },
    :attr_serial => { kind: :property, name: "attrSerial", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_type => { kind: :property, name: "attrType", is_optional: false },
    :certificate_ref => { kind: :property, name: "certificateRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :certificate => { kind: :property, name: "certificate", is_optional: false },
    :usage => { kind: :property, name: "usage", is_optional: false },
    :active_date => { kind: :property, name: "activeDate", is_optional: true },
    :certificate_chain => { kind: :property, name: "certificateChain", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :inactive_date => { kind: :property, name: "inactiveDate", is_optional: true },
    :private_key => { kind: :property, name: "privateKey", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#active_date ⇒ String?

An optional date that specifies when the certificate becomes active.

Returns:

  • (String, nil) 


335
336
337
 
# File 'transfer/cfn_certificate.rb', line 335

def active_date()
  jsii_get_property("activeDate")
end

#active_date=(value) ⇒ Object 



339
340
341
342
 
# File 'transfer/cfn_certificate.rb', line 339

def active_date=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "activeDate") unless value.nil?
  jsii_set_property("activeDate", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



441
442
443
444
 
# File 'transfer/cfn_certificate.rb', line 441

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



453
454
455
456
 
# File 'transfer/cfn_certificate.rb', line 453

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



463
464
465
466
 
# File 'transfer/cfn_certificate.rb', line 463

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



474
475
476
477
478
 
# File 'transfer/cfn_certificate.rb', line 474

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


531
532
533
534
535
 
# File 'transfer/cfn_certificate.rb', line 531

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



541
542
543
544
 
# File 'transfer/cfn_certificate.rb', line 541

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



553
554
555
556
557
 
# File 'transfer/cfn_certificate.rb', line 553

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



566
567
568
569
 
# File 'transfer/cfn_certificate.rb', line 566

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



588
589
590
591
592
593
 
# File 'transfer/cfn_certificate.rb', line 588

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

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

Returns:

  • (String) 


240
241
242
 
# File 'transfer/cfn_certificate.rb', line 240

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_certificate_id ⇒ String

An array of identifiers for the imported certificates.

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

Returns:

  • (String) 


249
250
251
 
# File 'transfer/cfn_certificate.rb', line 249

def attr_certificate_id()
  jsii_get_property("attrCertificateId")
end

#attr_not_after_date ⇒ String

The final date that the certificate is valid.

Returns:

  • (String) 


256
257
258
 
# File 'transfer/cfn_certificate.rb', line 256

def attr_not_after_date()
  jsii_get_property("attrNotAfterDate")
end

#attr_not_before_date ⇒ String

The earliest date that the certificate is valid.

Returns:

  • (String) 


263
264
265
 
# File 'transfer/cfn_certificate.rb', line 263

def attr_not_before_date()
  jsii_get_property("attrNotBeforeDate")
end

#attr_serial ⇒ String

The serial number for the certificate.

Returns:

  • (String) 


270
271
272
 
# File 'transfer/cfn_certificate.rb', line 270

def attr_serial()
  jsii_get_property("attrSerial")
end

#attr_status ⇒ String

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

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

Returns:

  • (String) 


279
280
281
 
# File 'transfer/cfn_certificate.rb', line 279

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_type ⇒ String

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 .

Returns:

  • (String) 


288
289
290
 
# File 'transfer/cfn_certificate.rb', line 288

def attr_type()
  jsii_get_property("attrType")
end

#certificate ⇒ String

The file name for the certificate.

Returns:

  • (String) 


309
310
311
 
# File 'transfer/cfn_certificate.rb', line 309

def certificate()
  jsii_get_property("certificate")
end

#certificate=(value) ⇒ Object 



313
314
315
316
 
# File 'transfer/cfn_certificate.rb', line 313

def certificate=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificate")
  jsii_set_property("certificate", value)
end

#certificate_chain ⇒ String?

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

Returns:

  • (String, nil) 


347
348
349
 
# File 'transfer/cfn_certificate.rb', line 347

def certificate_chain()
  jsii_get_property("certificateChain")
end

#certificate_chain=(value) ⇒ Object 



351
352
353
354
 
# File 'transfer/cfn_certificate.rb', line 351

def certificate_chain=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateChain") unless value.nil?
  jsii_set_property("certificateChain", value)
end

#certificate_ref ⇒ AWSCDK::Interfaces::AWSTransfer::CertificateReference

A reference to a Certificate resource.

Returns:



295
296
297
 
# File 'transfer/cfn_certificate.rb', line 295

def certificate_ref()
  jsii_get_property("certificateRef")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



186
187
188
 
# File 'transfer/cfn_certificate.rb', line 186

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'transfer/cfn_certificate.rb', line 191

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


597
598
599
600
 
# File 'transfer/cfn_certificate.rb', line 597

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


196
197
198
 
# File 'transfer/cfn_certificate.rb', line 196

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


203
204
205
 
# File 'transfer/cfn_certificate.rb', line 203

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


148
149
150
 
# File 'transfer/cfn_certificate.rb', line 148

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

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

Returns:

  • (String, nil) 


359
360
361
 
# File 'transfer/cfn_certificate.rb', line 359

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



363
364
365
366
 
# File 'transfer/cfn_certificate.rb', line 363

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



208
209
210
 
# File 'transfer/cfn_certificate.rb', line 208

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



610
611
612
613
614
 
# File 'transfer/cfn_certificate.rb', line 610

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



621
622
623
624
 
# File 'transfer/cfn_certificate.rb', line 621

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inactive_date ⇒ String?

An optional date that specifies when the certificate becomes inactive.

Returns:

  • (String, nil) 


371
372
373
 
# File 'transfer/cfn_certificate.rb', line 371

def inactive_date()
  jsii_get_property("inactiveDate")
end

#inactive_date=(value) ⇒ Object 



375
376
377
378
 
# File 'transfer/cfn_certificate.rb', line 375

def inactive_date=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inactiveDate") unless value.nil?
  jsii_set_property("inactiveDate", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



691
692
693
694
 
# File 'transfer/cfn_certificate.rb', line 691

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


160
161
162
 
# File 'transfer/cfn_certificate.rb', line 160

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


143
144
145
 
# File 'transfer/cfn_certificate.rb', line 143

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



632
633
634
 
# File 'transfer/cfn_certificate.rb', line 632

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



639
640
641
 
# File 'transfer/cfn_certificate.rb', line 639

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



432
433
434
435
 
# File 'transfer/cfn_certificate.rb', line 432

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#private_key ⇒ String?

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

Returns:

  • (String, nil) 


383
384
385
 
# File 'transfer/cfn_certificate.rb', line 383

def private_key()
  jsii_get_property("privateKey")
end

#private_key=(value) ⇒ Object 



387
388
389
390
 
# File 'transfer/cfn_certificate.rb', line 387

def private_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey") unless value.nil?
  jsii_set_property("privateKey", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


179
180
181
 
# File 'transfer/cfn_certificate.rb', line 179

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



650
651
652
653
 
# File 'transfer/cfn_certificate.rb', line 650

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


657
658
659
660
 
# File 'transfer/cfn_certificate.rb', line 657

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



667
668
669
670
671
 
# File 'transfer/cfn_certificate.rb', line 667

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



676
677
678
 
# File 'transfer/cfn_certificate.rb', line 676

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



169
170
171
 
# File 'transfer/cfn_certificate.rb', line 169

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



302
303
304
 
# File 'transfer/cfn_certificate.rb', line 302

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



395
396
397
 
# File 'transfer/cfn_certificate.rb', line 395

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



399
400
401
402
403
 
# File 'transfer/cfn_certificate.rb', line 399

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



408
409
410
 
# File 'transfer/cfn_certificate.rb', line 408

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


216
217
218
 
# File 'transfer/cfn_certificate.rb', line 216

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


226
227
228
 
# File 'transfer/cfn_certificate.rb', line 226

def updated_properties()
  jsii_get_property("updatedProperties")
end

#usage ⇒ String

Specifies how this certificate is used.

It can be used in the following ways:.

Returns:

  • (String) 


323
324
325
 
# File 'transfer/cfn_certificate.rb', line 323

def usage()
  jsii_get_property("usage")
end

#usage=(value) ⇒ Object 



327
328
329
330
 
# File 'transfer/cfn_certificate.rb', line 327

def usage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usage")
  jsii_set_property("usage", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


682
683
684
685
 
# File 'transfer/cfn_certificate.rb', line 682

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


421
422
423
424
425
426
 
# File 'transfer/cfn_certificate.rb', line 421

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end