Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the acm v1alpha1 API group +kubebuilder:object:generate=true +groupName=acm.aws.crossplane.io +versionName=v1alpha1
Package v1alpha1 contains API Schema definitions for the acm v1alpha1 API group +kubebuilder:object:generate=true +groupName=acm.aws.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Certificate
- func (in *Certificate) DeepCopy() *Certificate
- func (in *Certificate) DeepCopyInto(out *Certificate)
- func (in *Certificate) DeepCopyObject() runtime.Object
- func (mg *Certificate) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (mg *Certificate) GetDeletionPolicy() xpv1.DeletionPolicy
- func (mg *Certificate) GetProviderConfigReference() *xpv1.Reference
- func (mg *Certificate) GetProviderReference() *xpv1.Reference
- func (mg *Certificate) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Certificate) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (mg *Certificate) SetConditions(c ...xpv1.Condition)
- func (mg *Certificate) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Certificate) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Certificate) SetProviderReference(r *xpv1.Reference)
- func (mg *Certificate) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Certificate) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type CertificateExternalStatus
- type CertificateList
- type CertificateParameters
- type CertificateSpec
- type CertificateStatus
- type DomainValidationOption
- type ResourceRecord
- type Tag
Constants ¶
const ( Group = "acm.aws.crossplane.io" Version = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
var ( CertificateKind = reflect.TypeOf(Certificate{}).Name() CertificateGroupKind = schema.GroupKind{Group: Group, Kind: CertificateKind}.String() CertificateKindAPIVersion = CertificateKind + "." + SchemeGroupVersion.String() CertificateGroupVersionKind = SchemeGroupVersion.WithKind(CertificateKind) )
Certificate type metadata.
Functions ¶
This section is empty.
Types ¶
type Certificate ¶
type Certificate struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CertificateSpec `json:"spec"`
Status CertificateStatus `json:"status,omitempty"`
}
Certificate is a managed resource that represents an AWS Certificate Manager. +kubebuilder:printcolumn:name="DOMAINNAME",type="string",JSONPath=".spec.forProvider.domainName" +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.atProvider.status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws} +kubebuilder:deprecatedversion:warning="Please use v1beta1 version of this resource." Deprecated: Please use v1beta1 version of this resource.
func (*Certificate) DeepCopy ¶
func (in *Certificate) DeepCopy() *Certificate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Certificate.
func (*Certificate) DeepCopyInto ¶
func (in *Certificate) DeepCopyInto(out *Certificate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Certificate) DeepCopyObject ¶
func (in *Certificate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Certificate) GetCondition ¶
func (mg *Certificate) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Certificate.
func (*Certificate) GetDeletionPolicy ¶
func (mg *Certificate) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Certificate.
func (*Certificate) GetProviderConfigReference ¶
func (mg *Certificate) GetProviderConfigReference() *xpv1.Reference
GetProviderConfigReference of this Certificate.
func (*Certificate) GetProviderReference ¶
func (mg *Certificate) GetProviderReference() *xpv1.Reference
GetProviderReference of this Certificate. Deprecated: Use GetProviderConfigReference.
func (*Certificate) GetPublishConnectionDetailsTo ¶
func (mg *Certificate) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Certificate.
func (*Certificate) GetWriteConnectionSecretToReference ¶
func (mg *Certificate) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Certificate.
func (*Certificate) SetConditions ¶
func (mg *Certificate) SetConditions(c ...xpv1.Condition)
SetConditions of this Certificate.
func (*Certificate) SetDeletionPolicy ¶
func (mg *Certificate) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Certificate.
func (*Certificate) SetProviderConfigReference ¶
func (mg *Certificate) SetProviderConfigReference(r *xpv1.Reference)
SetProviderConfigReference of this Certificate.
func (*Certificate) SetProviderReference ¶
func (mg *Certificate) SetProviderReference(r *xpv1.Reference)
SetProviderReference of this Certificate. Deprecated: Use SetProviderConfigReference.
func (*Certificate) SetPublishConnectionDetailsTo ¶
func (mg *Certificate) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Certificate.
func (*Certificate) SetWriteConnectionSecretToReference ¶
func (mg *Certificate) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Certificate.
type CertificateExternalStatus ¶
type CertificateExternalStatus struct {
// String that contains the ARN of the issued certificate. This must be of the
CertificateARN string `json:"certificateARN,omitempty"`
// Flag to check eligibility for renewal status
// +kubebuilder:validation:Enum=ELIGIBLE;INELIGIBLE
RenewalEligibility types.RenewalEligibility `json:"renewalEligibility,omitempty"`
// Status of the certificate
// +kubebuilder:validation:Enum=PENDING_VALIDATION;ISSUED;INACTIVE;EXPIRED;VALIDATION_TIMED_OUT;REVOKED;FAILED
Status types.CertificateStatus `json:"status,omitempty"`
// Type of the certificate
// +kubebuilder:validation:Enum=IMPORTED;AMAZON_ISSUED;PRIVATE
Type types.CertificateType `json:"type,omitempty"`
// Contains the CNAME record that you add to your DNS database for domain
// validation. For more information, see Use DNS to Validate Domain Ownership
// (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html).
// Note: The CNAME information that you need does not include the name of your
// domain. If you include your domain name in the DNS database CNAME record,
// validation fails. For example, if the name is
// "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only
// "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.
ResourceRecord *ResourceRecord `json:"resourceRecord,omitempty"`
}
CertificateExternalStatus keeps the state of external resource
func (*CertificateExternalStatus) DeepCopy ¶
func (in *CertificateExternalStatus) DeepCopy() *CertificateExternalStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateExternalStatus.
func (*CertificateExternalStatus) DeepCopyInto ¶
func (in *CertificateExternalStatus) DeepCopyInto(out *CertificateExternalStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateList ¶
type CertificateList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Certificate `json:"items"`
}
CertificateList contains a list of Certificate. +kubebuilder:deprecatedversion:warning="Please use v1beta1 version of this resource." Deprecated: Please use v1beta1 version of this resource.
func (*CertificateList) DeepCopy ¶
func (in *CertificateList) DeepCopy() *CertificateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateList.
func (*CertificateList) DeepCopyInto ¶
func (in *CertificateList) DeepCopyInto(out *CertificateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateList) DeepCopyObject ¶
func (in *CertificateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*CertificateList) GetItems ¶
func (l *CertificateList) GetItems() []resource.Managed
GetItems of this CertificateList.
type CertificateParameters ¶
type CertificateParameters struct {
// Region is the region you'd like your Certificate to be created in.
Region string `json:"region"`
// The Amazon Resource Name (ARN) of the private certificate authority (CA)that will be used to issue the certificate.
// +optional
CertificateAuthorityARN *string `json:"certificateAuthorityARN,omitempty"`
// CertificateAuthorityARNRef references an AWS ACMPCA CertificateAuthority to retrieve its Arn
// +optional
CertificateAuthorityARNRef *xpv1.Reference `json:"certificateAuthorityARNRef,omitempty"`
// CertificateAuthorityARNSelector selects a reference to an AWS ACMPCA CertificateAuthority to retrieve its Arn
// +optional
CertificateAuthorityARNSelector *xpv1.Selector `json:"certificateAuthorityARNSelector,omitempty"`
// Fully qualified domain name (FQDN),that to secure with an ACM certificate.
// +immutable
DomainName string `json:"domainName"`
// The domain name that you want ACM to use to send you emails so that you can
// validate domain ownership.
// +optional
// +immutable
DomainValidationOptions []*DomainValidationOption `json:"domainValidationOptions,omitempty"`
// Parameter add the certificate to a certificate transparency log.
// +optional
// +kubebuilder:validation:Enum=ENABLED;DISABLED
CertificateTransparencyLoggingPreference *types.CertificateTransparencyLoggingPreference `json:"certificateTransparencyLoggingPreference,omitempty"`
// Subject Alternative Name extension of the ACM certificate.
// +optional
// +immutable
SubjectAlternativeNames []*string `json:"subjectAlternativeNames,omitempty"`
// One or more resource tags to associate with the certificate.
Tags []Tag `json:"tags"`
// Method to validate certificate.
// +optional
// +kubebuilder:validation:Enum=DNS;EMAIL
ValidationMethod *types.ValidationMethod `json:"validationMethod,omitempty"`
// Flag to renew the certificate
// +optional
RenewCertificate *bool `json:"renewCertificate,omitempty"`
}
CertificateParameters defines the desired state of an AWS Certificate.
func (*CertificateParameters) DeepCopy ¶
func (in *CertificateParameters) DeepCopy() *CertificateParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateParameters.
func (*CertificateParameters) DeepCopyInto ¶
func (in *CertificateParameters) DeepCopyInto(out *CertificateParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateSpec ¶
type CertificateSpec struct {
xpv1.ResourceSpec `json:",inline"`
ForProvider CertificateParameters `json:"forProvider"`
}
CertificateSpec defines the desired state of Certificate
func (*CertificateSpec) DeepCopy ¶
func (in *CertificateSpec) DeepCopy() *CertificateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSpec.
func (*CertificateSpec) DeepCopyInto ¶
func (in *CertificateSpec) DeepCopyInto(out *CertificateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateStatus ¶
type CertificateStatus struct {
xpv1.ResourceStatus `json:",inline"`
AtProvider CertificateExternalStatus `json:"atProvider,omitempty"`
}
An CertificateStatus represents the observed state of an Certificate manager.
func (*CertificateStatus) DeepCopy ¶
func (in *CertificateStatus) DeepCopy() *CertificateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateStatus.
func (*CertificateStatus) DeepCopyInto ¶
func (in *CertificateStatus) DeepCopyInto(out *CertificateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DomainValidationOption ¶
type DomainValidationOption struct {
// Additinal Fully qualified domain name (FQDN),that to secure with an ACM certificate.
// +immutable
DomainName string `json:"domainName"`
// Method to validate certificate
// +immutable
ValidationDomain string `json:"validationDomain"`
}
DomainValidationOption validate domain ownership.
func (*DomainValidationOption) DeepCopy ¶
func (in *DomainValidationOption) DeepCopy() *DomainValidationOption
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainValidationOption.
func (*DomainValidationOption) DeepCopyInto ¶
func (in *DomainValidationOption) DeepCopyInto(out *DomainValidationOption)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceRecord ¶
type ResourceRecord struct {
// The name of the DNS record to create in your domain. This is supplied by ACM.
Name *string `json:"name,omitempty"`
// The type of DNS record. Currently this can be CNAME.
// +kubebuilder:validation:Enum=CNAME
Type *string `json:"type,omitempty"`
// The value of the CNAME record to add to your DNS database.
Value *string `json:"value,omitempty"`
}
ResourceRecord Contains a DNS record value that you can use to validate ownership or control of a domain.
func (*ResourceRecord) DeepCopy ¶
func (in *ResourceRecord) DeepCopy() *ResourceRecord
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceRecord.
func (*ResourceRecord) DeepCopyInto ¶
func (in *ResourceRecord) DeepCopyInto(out *ResourceRecord)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tag ¶
type Tag struct {
// The key name that can be used to look up or retrieve the associated value.
Key string `json:"key"`
// The value associated with this tag.
Value string `json:"value"`
}
Tag represents user-provided metadata that can be associated
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.