awscertificatemanager

package
v2.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 8, 2021 License: Apache-2.0 Imports: 10 Imported by: 31

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Certificate_IsConstruct 

func Certificate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Certificate_IsResource 

func Certificate_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func CfnAccount_CFN_RESOURCE_TYPE_NAME 

func CfnAccount_CFN_RESOURCE_TYPE_NAME() *string

func CfnAccount_IsCfnElement 

func CfnAccount_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAccount_IsCfnResource 

func CfnAccount_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAccount_IsConstruct 

func CfnAccount_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnCertificate_CFN_RESOURCE_TYPE_NAME 

func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string

func CfnCertificate_IsCfnElement 

func CfnCertificate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCertificate_IsCfnResource 

func CfnCertificate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCertificate_IsConstruct 

func CfnCertificate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DnsValidatedCertificate_IsConstruct 

func DnsValidatedCertificate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DnsValidatedCertificate_IsResource 

func DnsValidatedCertificate_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func NewCertificate_Override 

func NewCertificate_Override(c Certificate, scope constructs.Construct, id *string, props *CertificateProps)

func NewCfnAccount_Override 

func NewCfnAccount_Override(c CfnAccount, scope constructs.Construct, id *string, props *CfnAccountProps)

Create a new `AWS::CertificateManager::Account`.

func NewCfnCertificate_Override 

func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)

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

func NewDnsValidatedCertificate_Override 

func NewDnsValidatedCertificate_Override(d DnsValidatedCertificate, scope constructs.Construct, id *string, props *DnsValidatedCertificateProps)

func NewPrivateCertificate_Override 

func NewPrivateCertificate_Override(p PrivateCertificate, scope constructs.Construct, id *string, props *PrivateCertificateProps)

func PrivateCertificate_IsConstruct 

func PrivateCertificate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func PrivateCertificate_IsResource 

func PrivateCertificate_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type Certificate 

type Certificate interface {
	awscdk.Resource
	ICertificate
	CertificateArn() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Region() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	MetricDaysToExpiry(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A certificate managed by AWS Certificate Manager.

TODO: EXAMPLE

func NewCertificate 

func NewCertificate(scope constructs.Construct, id *string, props *CertificateProps) Certificate

type CertificateProps 

type CertificateProps struct {
	// Fully-qualified domain name to request a certificate for.
	//
	// May contain wildcards, such as “*.domain.com“.
	DomainName *string `json:"domainName"`
	// Alternative domain names on your certificate.
	//
	// Use this to register alternative domain names that represent the same site.
	SubjectAlternativeNames *[]*string `json:"subjectAlternativeNames"`
	// How to validate this certificate.
	Validation CertificateValidation `json:"validation"`
}

Properties for your certificate.

TODO: EXAMPLE

type CertificateValidation 

type CertificateValidation interface {
	Method() ValidationMethod
	Props() *CertificationValidationProps
}

How to validate a certificate.

TODO: EXAMPLE

func CertificateValidation_FromDns 

func CertificateValidation_FromDns(hostedZone awsroute53.IHostedZone) CertificateValidation

Validate the certificate with DNS.

IMPORTANT: If `hostedZone` is not specified, DNS records must be added manually and the stack will not complete creating until the records are added.

func CertificateValidation_FromDnsMultiZone 

func CertificateValidation_FromDnsMultiZone(hostedZones *map[string]awsroute53.IHostedZone) CertificateValidation

Validate the certificate with automatically created DNS records in multiple Amazon Route 53 hosted zones.

func CertificateValidation_FromEmail 

func CertificateValidation_FromEmail(validationDomains *map[string]*string) CertificateValidation

Validate the certificate with Email.

IMPORTANT: if you are creating a certificate as part of your stack, the stack will not complete creating until you read and follow the instructions in the email that you will receive.

ACM will send validation emails to the following addresses: 

admin@domain.com
administrator@domain.com
hostmaster@domain.com
postmaster@domain.com
webmaster@domain.com

For every domain that you register.

type CertificationValidationProps 

type CertificationValidationProps struct {
	// Hosted zone to use for DNS validation.
	HostedZone awsroute53.IHostedZone `json:"hostedZone"`
	// A map of hosted zones to use for DNS validation.
	HostedZones *map[string]awsroute53.IHostedZone `json:"hostedZones"`
	// Validation method.
	Method ValidationMethod `json:"method"`
	// Validation domains to use for email validation.
	ValidationDomains *map[string]*string `json:"validationDomains"`
}

Properties for certificate validation.

TODO: EXAMPLE

type CfnAccount 

type CfnAccount interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAccountId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ExpiryEventsConfiguration() interface{}
	SetExpiryEventsConfiguration(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CertificateManager::Account`.

TODO: EXAMPLE

func NewCfnAccount 

func NewCfnAccount(scope constructs.Construct, id *string, props *CfnAccountProps) CfnAccount

Create a new `AWS::CertificateManager::Account`.

type CfnAccountProps 

type CfnAccountProps struct {
	// `AWS::CertificateManager::Account.ExpiryEventsConfiguration`.
	ExpiryEventsConfiguration interface{} `json:"expiryEventsConfiguration"`
}

Properties for defining a `AWS::CertificateManager::Account`.

TODO: EXAMPLE

type CfnAccount_ExpiryEventsConfigurationProperty 

type CfnAccount_ExpiryEventsConfigurationProperty struct {
	// `CfnAccount.ExpiryEventsConfigurationProperty.DaysBeforeExpiry`.
	DaysBeforeExpiry *float64 `json:"daysBeforeExpiry"`
}

TODO: EXAMPLE

type CfnCertificate 

type CfnCertificate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CertificateAuthorityArn() *string
	SetCertificateAuthorityArn(val *string)
	CertificateTransparencyLoggingPreference() *string
	SetCertificateTransparencyLoggingPreference(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainName() *string
	SetDomainName(val *string)
	DomainValidationOptions() interface{}
	SetDomainValidationOptions(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	SubjectAlternativeNames() *[]*string
	SetSubjectAlternativeNames(val *[]*string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	ValidationMethod() *string
	SetValidationMethod(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CertificateManager::Certificate`.

TODO: EXAMPLE

func NewCfnCertificate 

func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate

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

type CfnCertificateProps 

type CfnCertificateProps struct {
	// `AWS::CertificateManager::Certificate.CertificateAuthorityArn`.
	CertificateAuthorityArn *string `json:"certificateAuthorityArn"`
	// `AWS::CertificateManager::Certificate.CertificateTransparencyLoggingPreference`.
	CertificateTransparencyLoggingPreference *string `json:"certificateTransparencyLoggingPreference"`
	// `AWS::CertificateManager::Certificate.DomainName`.
	DomainName *string `json:"domainName"`
	// `AWS::CertificateManager::Certificate.DomainValidationOptions`.
	DomainValidationOptions interface{} `json:"domainValidationOptions"`
	// `AWS::CertificateManager::Certificate.SubjectAlternativeNames`.
	SubjectAlternativeNames *[]*string `json:"subjectAlternativeNames"`
	// `AWS::CertificateManager::Certificate.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::CertificateManager::Certificate.ValidationMethod`.
	ValidationMethod *string `json:"validationMethod"`
}

Properties for defining a `AWS::CertificateManager::Certificate`.

TODO: EXAMPLE

type CfnCertificate_DomainValidationOptionProperty 

type CfnCertificate_DomainValidationOptionProperty struct {
	// `CfnCertificate.DomainValidationOptionProperty.DomainName`.
	DomainName *string `json:"domainName"`
	// `CfnCertificate.DomainValidationOptionProperty.HostedZoneId`.
	HostedZoneId *string `json:"hostedZoneId"`
	// `CfnCertificate.DomainValidationOptionProperty.ValidationDomain`.
	ValidationDomain *string `json:"validationDomain"`
}

TODO: EXAMPLE

type DnsValidatedCertificate 

type DnsValidatedCertificate interface {
	awscdk.Resource
	ICertificate
	awscdk.ITaggable
	CertificateArn() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Region() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	MetricDaysToExpiry(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A certificate managed by AWS Certificate Manager.

Will be automatically validated using DNS validation against the specified Route 53 hosted zone.

TODO: EXAMPLE

func NewDnsValidatedCertificate 

func NewDnsValidatedCertificate(scope constructs.Construct, id *string, props *DnsValidatedCertificateProps) DnsValidatedCertificate

type DnsValidatedCertificateProps 

type DnsValidatedCertificateProps struct {
	// Fully-qualified domain name to request a certificate for.
	//
	// May contain wildcards, such as “*.domain.com“.
	DomainName *string `json:"domainName"`
	// Alternative domain names on your certificate.
	//
	// Use this to register alternative domain names that represent the same site.
	SubjectAlternativeNames *[]*string `json:"subjectAlternativeNames"`
	// How to validate this certificate.
	Validation CertificateValidation `json:"validation"`
	// Route 53 Hosted Zone used to perform DNS validation of the request.
	//
	// The zone
	// must be authoritative for the domain name specified in the Certificate Request.
	HostedZone awsroute53.IHostedZone `json:"hostedZone"`
	// Role to use for the custom resource that creates the validated certificate.
	CustomResourceRole awsiam.IRole `json:"customResourceRole"`
	// AWS region that will host the certificate.
	//
	// This is needed especially
	// for certificates used for CloudFront distributions, which require the region
	// to be us-east-1.
	Region *string `json:"region"`
	// An endpoint of Route53 service, which is not necessary as AWS SDK could figure out the right endpoints for most regions, but for some regions such as those in aws-cn partition, the default endpoint is not working now, hence the right endpoint need to be specified through this prop.
	//
	// Route53 is not been officially launched in China, it is only available for AWS
	// internal accounts now. To make DnsValidatedCertificate work for internal accounts
	// now, a special endpoint needs to be provided.
	Route53Endpoint *string `json:"route53Endpoint"`
}

Properties to create a DNS validated certificate managed by AWS Certificate Manager.

TODO: EXAMPLE

type ICertificate 

type ICertificate interface {
	awscdk.IResource
	// 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".
	MetricDaysToExpiry(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The certificate's ARN.
	CertificateArn() *string
}

Represents a certificate in AWS Certificate Manager.

func Certificate_FromCertificateArn 

func Certificate_FromCertificateArn(scope constructs.Construct, id *string, certificateArn *string) ICertificate

Import a certificate.

func PrivateCertificate_FromCertificateArn 

func PrivateCertificate_FromCertificateArn(scope constructs.Construct, id *string, certificateArn *string) ICertificate

Import a certificate.

type PrivateCertificate 

type PrivateCertificate interface {
	awscdk.Resource
	ICertificate
	CertificateArn() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Region() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	MetricDaysToExpiry(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A private certificate managed by AWS Certificate Manager.

TODO: EXAMPLE

func NewPrivateCertificate 

func NewPrivateCertificate(scope constructs.Construct, id *string, props *PrivateCertificateProps) PrivateCertificate

type PrivateCertificateProps 

type PrivateCertificateProps struct {
	// Private certificate authority (CA) that will be used to issue the certificate.
	CertificateAuthority awsacmpca.ICertificateAuthority `json:"certificateAuthority"`
	// Fully-qualified domain name to request a private certificate for.
	//
	// May contain wildcards, such as “*.domain.com“.
	DomainName *string `json:"domainName"`
	// Alternative domain names on your private certificate.
	//
	// Use this to register alternative domain names that represent the same site.
	SubjectAlternativeNames *[]*string `json:"subjectAlternativeNames"`
}

Properties for your private certificate.

TODO: EXAMPLE

type ValidationMethod 

type ValidationMethod string

Method used to assert ownership of the domain. 

const (
	ValidationMethod_DNS   ValidationMethod = "DNS"
	ValidationMethod_EMAIL ValidationMethod = "EMAIL"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.