Certificate¶
-
class
aws_cdk.aws_certificatemanager.
Certificate
(scope, id, *, domain_name, subject_alternative_names=None, validation=None, validation_domains=None, validation_method=None)¶ Bases:
aws_cdk.core.Resource
A certificate managed by AWS Certificate Manager.
- ExampleMetadata
infused
Example:
pool = cognito.UserPool(self, "Pool") pool.add_domain("CognitoDomain", cognito_domain=cognito.CognitoDomainOptions( domain_prefix="my-awesome-app" ) ) certificate_arn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d" domain_cert = certificatemanager.Certificate.from_certificate_arn(self, "domainCert", certificate_arn) pool.add_domain("CustomDomain", custom_domain=cognito.CustomDomainOptions( domain_name="user.myapp.com", certificate=domain_cert ) )
- Parameters
scope (
Construct
) –id (
str
) –domain_name (
str
) – Fully-qualified domain name to request a certificate for. May contain wildcards, such as*.domain.com
.subject_alternative_names (
Optional
[Sequence
[str
]]) – Alternative domain names on your certificate. Use this to register alternative domain names that represent the same site. Default: - No additional FQDNs will be included as alternative domain names.validation (
Optional
[CertificateValidation
]) – How to validate this certificate. Default: CertificateValidation.fromEmail()validation_domains (
Optional
[Mapping
[str
,str
]]) – (deprecated) What validation domain to use for every requested domain. Has to be a superdomain of the requested domain. Default: - Apex domain is used for every domain that’s not overridden.validation_method (
Optional
[ValidationMethod
]) – (deprecated) Validation method used to assert domain ownership. Default: ValidationMethod.EMAIL
Methods
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
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
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
metric_days_to_expiry
(*, account=None, color=None, dimensions=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)¶ Return the DaysToExpiry metric for this AWS Certificate Manager Certificate. By default, this is the minimum value over 1 day.
This metric is no longer emitted once the certificate has effectively expired, so alarms configured on this metric should probably treat missing data as “breaching”.
- Parameters
account (
Optional
[str
]) – Account which this metric comes from. Default: - Deployment account.color (
Optional
[str
]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions (
Optional
[Mapping
[str
,Any
]]) – (deprecated) Dimensions of the metric. Default: - No dimensions.dimensions_map (
Optional
[Mapping
[str
,str
]]) – Dimensions of the metric. Default: - No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No labelperiod (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)region (
Optional
[str
]) – Region which this metric comes from. Default: - Deployment region.statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
- Return type
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
certificate_arn
¶ The certificate’s ARN.
- Return type
str
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_certificate_arn
(scope, id, certificate_arn)¶ Import a certificate.
- Parameters
scope (
Construct
) –id (
str
) –certificate_arn (
str
) –
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool