types

package
v1.5.7 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControlEntry 

type AccessControlEntry struct {

	// Permissions to allow or deny an Active Directory group to enroll or autoenroll
	// certificates issued against a template.
	AccessRights *AccessRights

	// The date and time that the Access Control Entry was created.
	CreatedAt *time.Time

	// Name of the Active Directory group. This name does not need to match the group
	// name in Active Directory.
	GroupDisplayName *string

	// Security identifier (SID) of the group object from Active Directory. The SID
	// starts with "S-".
	GroupSecurityIdentifier *string

	// The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
	TemplateArn *string

	// The date and time that the Access Control Entry was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}
An access control entry allows or denies Active Directory groups based on

their security identifiers (SIDs) from enrolling and/or autoenrolling with the template.

type AccessControlEntrySummary 

type AccessControlEntrySummary struct {

	// Allow or deny an Active Directory group from enrolling and autoenrolling
	// certificates issued against a template.
	AccessRights *AccessRights

	// The date and time that the Access Control Entry was created.
	CreatedAt *time.Time

	// Name of the Active Directory group. This name does not need to match the group
	// name in Active Directory.
	GroupDisplayName *string

	// Security identifier (SID) of the group object from Active Directory. The SID
	// starts with "S-".
	GroupSecurityIdentifier *string

	// The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
	TemplateArn *string

	// The date and time that the Access Control Entry was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Summary of group access control entries that allow or deny Active Directory groups based on their security identifiers (SIDs) from enrolling and/or autofenrolling with the template.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccessRight 

type AccessRight string
const (
	AccessRightAllow AccessRight = "ALLOW"
	AccessRightDeny  AccessRight = "DENY"
)

Enum values for AccessRight

func (AccessRight) Values 

func (AccessRight) Values() []AccessRight

Values returns all known values for AccessRight. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccessRights 

type AccessRights struct {

	// Allow or deny an Active Directory group from autoenrolling certificates issued
	// against a template. The Active Directory group must be allowed to enroll to
	// allow autoenrollment
	AutoEnroll AccessRight

	// Allow or deny an Active Directory group from enrolling certificates issued
	// against a template.
	Enroll AccessRight
	// contains filtered or unexported fields
}
Allow or deny permissions for an Active Directory group to enroll or

autoenroll certificates for a template.

type ApplicationPolicies 

type ApplicationPolicies struct {

	// Application policies describe what the certificate can be used for.
	//
	// This member is required.
	Policies []ApplicationPolicy

	// Marks the application policy extension as critical.
	Critical *bool
	// contains filtered or unexported fields
}

Application policies describe what the certificate can be used for.

type ApplicationPolicy 

type ApplicationPolicy interface {
	// contains filtered or unexported methods
}

Application policies describe what the certificate can be used for.

The following types satisfy this interface: 

ApplicationPolicyMemberPolicyObjectIdentifier
ApplicationPolicyMemberPolicyType
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/pcaconnectorad/types"
)

func main() {
	var union types.ApplicationPolicy
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ApplicationPolicyMemberPolicyObjectIdentifier:
		_ = v.Value // Value is string

	case *types.ApplicationPolicyMemberPolicyType:
		_ = v.Value // Value is types.ApplicationPolicyType

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ApplicationPolicyMemberPolicyObjectIdentifier 

type ApplicationPolicyMemberPolicyObjectIdentifier struct {
	Value string
	// contains filtered or unexported fields
}

The object identifier (OID) of an application policy.

type ApplicationPolicyMemberPolicyType 

type ApplicationPolicyMemberPolicyType struct {
	Value ApplicationPolicyType
	// contains filtered or unexported fields
}

The type of application policy

type ApplicationPolicyType 

type ApplicationPolicyType string
const (
	ApplicationPolicyTypeAllApplicationPolicies                     ApplicationPolicyType = "ALL_APPLICATION_POLICIES"
	ApplicationPolicyTypeAnyPurpose                                 ApplicationPolicyType = "ANY_PURPOSE"
	ApplicationPolicyTypeAttestationIdentityKeyCertificate          ApplicationPolicyType = "ATTESTATION_IDENTITY_KEY_CERTIFICATE"
	ApplicationPolicyTypeCertificateRequestAgent                    ApplicationPolicyType = "CERTIFICATE_REQUEST_AGENT"
	ApplicationPolicyTypeClientAuthentication                       ApplicationPolicyType = "CLIENT_AUTHENTICATION"
	ApplicationPolicyTypeCodeSigning                                ApplicationPolicyType = "CODE_SIGNING"
	ApplicationPolicyTypeCtlUsage                                   ApplicationPolicyType = "CTL_USAGE"
	ApplicationPolicyTypeDigitalRights                              ApplicationPolicyType = "DIGITAL_RIGHTS"
	ApplicationPolicyTypeDirectoryServiceEmailReplication           ApplicationPolicyType = "DIRECTORY_SERVICE_EMAIL_REPLICATION"
	ApplicationPolicyTypeDisallowedList                             ApplicationPolicyType = "DISALLOWED_LIST"
	ApplicationPolicyTypeDnsServerTrust                             ApplicationPolicyType = "DNS_SERVER_TRUST"
	ApplicationPolicyTypeDocumentEncryption                         ApplicationPolicyType = "DOCUMENT_ENCRYPTION"
	ApplicationPolicyTypeDocumentSigning                            ApplicationPolicyType = "DOCUMENT_SIGNING"
	ApplicationPolicyTypeDynamicCodeGenerator                       ApplicationPolicyType = "DYNAMIC_CODE_GENERATOR"
	ApplicationPolicyTypeEarlyLaunchAntimalwareDriver               ApplicationPolicyType = "EARLY_LAUNCH_ANTIMALWARE_DRIVER"
	ApplicationPolicyTypeEmbeddedWindowsSystemComponentVerification ApplicationPolicyType = "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION"
	ApplicationPolicyTypeEnclave                                    ApplicationPolicyType = "ENCLAVE"
	ApplicationPolicyTypeEncryptingFileSystem                       ApplicationPolicyType = "ENCRYPTING_FILE_SYSTEM"
	ApplicationPolicyTypeEndorsementKeyCertificate                  ApplicationPolicyType = "ENDORSEMENT_KEY_CERTIFICATE"
	ApplicationPolicyTypeFileRecovery                               ApplicationPolicyType = "FILE_RECOVERY"
	ApplicationPolicyTypeHalExtension                               ApplicationPolicyType = "HAL_EXTENSION"
	ApplicationPolicyTypeIpSecurityEndSystem                        ApplicationPolicyType = "IP_SECURITY_END_SYSTEM"
	ApplicationPolicyTypeIpSecurityIkeIntermediate                  ApplicationPolicyType = "IP_SECURITY_IKE_INTERMEDIATE"
	ApplicationPolicyTypeIpSecurityTunnelTermination                ApplicationPolicyType = "IP_SECURITY_TUNNEL_TERMINATION"
	ApplicationPolicyTypeIpSecurityUser                             ApplicationPolicyType = "IP_SECURITY_USER"
	ApplicationPolicyTypeIsolatedUserMode                           ApplicationPolicyType = "ISOLATED_USER_MODE"
	ApplicationPolicyTypeKdcAuthentication                          ApplicationPolicyType = "KDC_AUTHENTICATION"
	ApplicationPolicyTypeKernelModeCodeSigning                      ApplicationPolicyType = "KERNEL_MODE_CODE_SIGNING"
	ApplicationPolicyTypeKeyPackLicenses                            ApplicationPolicyType = "KEY_PACK_LICENSES"
	ApplicationPolicyTypeKeyRecovery                                ApplicationPolicyType = "KEY_RECOVERY"
	ApplicationPolicyTypeKeyRecoveryAgent                           ApplicationPolicyType = "KEY_RECOVERY_AGENT"
	ApplicationPolicyTypeLicenseServerVerification                  ApplicationPolicyType = "LICENSE_SERVER_VERIFICATION"
	ApplicationPolicyTypeLifetimeSigning                            ApplicationPolicyType = "LIFETIME_SIGNING"
	ApplicationPolicyTypeMicrosoftPublisher                         ApplicationPolicyType = "MICROSOFT_PUBLISHER"
	ApplicationPolicyTypeMicrosoftTimeStamping                      ApplicationPolicyType = "MICROSOFT_TIME_STAMPING"
	ApplicationPolicyTypeMicrosoftTrustListSigning                  ApplicationPolicyType = "MICROSOFT_TRUST_LIST_SIGNING"
	ApplicationPolicyTypeOcspSigning                                ApplicationPolicyType = "OCSP_SIGNING"
	ApplicationPolicyTypeOemWindowsSystemComponentVerification      ApplicationPolicyType = "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION"
	ApplicationPolicyTypePlatformCertificate                        ApplicationPolicyType = "PLATFORM_CERTIFICATE"
	ApplicationPolicyTypePreviewBuildSigning                        ApplicationPolicyType = "PREVIEW_BUILD_SIGNING"
	ApplicationPolicyTypePrivateKeyArchival                         ApplicationPolicyType = "PRIVATE_KEY_ARCHIVAL"
	ApplicationPolicyTypeProtectedProcessLightVerification          ApplicationPolicyType = "PROTECTED_PROCESS_LIGHT_VERIFICATION"
	ApplicationPolicyTypeProtectedProcessVerification               ApplicationPolicyType = "PROTECTED_PROCESS_VERIFICATION"
	ApplicationPolicyTypeQualifiedSubordination                     ApplicationPolicyType = "QUALIFIED_SUBORDINATION"
	ApplicationPolicyTypeRevokedListSigner                          ApplicationPolicyType = "REVOKED_LIST_SIGNER"
	ApplicationPolicyTypeRootProgramAutoUpdateCaRevocation          ApplicationPolicyType = "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION"
	ApplicationPolicyTypeRootProgramAutoUpdateEndRevocation         ApplicationPolicyType = "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION"
	ApplicationPolicyTypeRootProgramNoOscpFailoverToCrl             ApplicationPolicyType = "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL"
	ApplicationPolicyTypeRootListSigner                             ApplicationPolicyType = "ROOT_LIST_SIGNER"
	ApplicationPolicyTypeSecureEmail                                ApplicationPolicyType = "SECURE_EMAIL"
	ApplicationPolicyTypeServerAuthentication                       ApplicationPolicyType = "SERVER_AUTHENTICATION"
	ApplicationPolicyTypeSmartCardLogin                             ApplicationPolicyType = "SMART_CARD_LOGIN"
	ApplicationPolicyTypeSpcEncryptedDigestRetryCount               ApplicationPolicyType = "SPC_ENCRYPTED_DIGEST_RETRY_COUNT"
	ApplicationPolicyTypeSpcRelaxedPeMarkerCheck                    ApplicationPolicyType = "SPC_RELAXED_PE_MARKER_CHECK"
	ApplicationPolicyTypeTimeStamping                               ApplicationPolicyType = "TIME_STAMPING"
	ApplicationPolicyTypeWindowsHardwareDriverAttestedVerification  ApplicationPolicyType = "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION"
	ApplicationPolicyTypeWindowsHardwareDriverExtendedVerification  ApplicationPolicyType = "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION"
	ApplicationPolicyTypeWindowsHardwareDriverVerification          ApplicationPolicyType = "WINDOWS_HARDWARE_DRIVER_VERIFICATION"
	ApplicationPolicyTypeWindowsHelloRecoveryKeyEncryption          ApplicationPolicyType = "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION"
	ApplicationPolicyTypeWindowsKitsComponent                       ApplicationPolicyType = "WINDOWS_KITS_COMPONENT"
	ApplicationPolicyTypeWindowsRtVerification                      ApplicationPolicyType = "WINDOWS_RT_VERIFICATION"
	ApplicationPolicyTypeWindowsSoftwareExtensionVerification       ApplicationPolicyType = "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION"
	ApplicationPolicyTypeWindowsStore                               ApplicationPolicyType = "WINDOWS_STORE"
	ApplicationPolicyTypeWindowsSystemComponentVerification         ApplicationPolicyType = "WINDOWS_SYSTEM_COMPONENT_VERIFICATION"
	ApplicationPolicyTypeWindowsTcbComponent                        ApplicationPolicyType = "WINDOWS_TCB_COMPONENT"
	ApplicationPolicyTypeWindowsThirdPartyApplicationComponent      ApplicationPolicyType = "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT"
	ApplicationPolicyTypeWindowsUpdate                              ApplicationPolicyType = "WINDOWS_UPDATE"
)

Enum values for ApplicationPolicyType

func (ApplicationPolicyType) Values 

func (ApplicationPolicyType) Values() []ApplicationPolicyType

Values returns all known values for ApplicationPolicyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateValidity 

type CertificateValidity struct {

	// Renewal period is the period of time before certificate expiration when a new
	// certificate will be requested.
	//
	// This member is required.
	RenewalPeriod *ValidityPeriod

	// Information describing the end of the validity period of the certificate. This
	// parameter sets the “Not After” date for the certificate. Certificate validity is
	// the period of time during which a certificate is valid. Validity can be
	// expressed as an explicit date and time when the certificate expires, or as a
	// span of time after issuance, stated in days, months, or years. For more
	// information, see Validity in RFC 5280. This value is unaffected when
	// ValidityNotBefore is also specified. For example, if Validity is set to 20 days
	// in the future, the certificate will expire 20 days from issuance time regardless
	// of the ValidityNotBefore value.
	//
	// This member is required.
	ValidityPeriod *ValidityPeriod
	// contains filtered or unexported fields
}

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

type ClientCompatibilityV2 

type ClientCompatibilityV2 string
const (
	ClientCompatibilityV2WindowsServer2003   ClientCompatibilityV2 = "WINDOWS_SERVER_2003"
	ClientCompatibilityV2WindowsServer2008   ClientCompatibilityV2 = "WINDOWS_SERVER_2008"
	ClientCompatibilityV2WindowsServer2008R2 ClientCompatibilityV2 = "WINDOWS_SERVER_2008_R2"
	ClientCompatibilityV2WindowsServer2012   ClientCompatibilityV2 = "WINDOWS_SERVER_2012"
	ClientCompatibilityV2WindowsServer2012R2 ClientCompatibilityV2 = "WINDOWS_SERVER_2012_R2"
	ClientCompatibilityV2WindowsServer2016   ClientCompatibilityV2 = "WINDOWS_SERVER_2016"
)

Enum values for ClientCompatibilityV2

func (ClientCompatibilityV2) Values 

func (ClientCompatibilityV2) Values() []ClientCompatibilityV2

Values returns all known values for ClientCompatibilityV2. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ClientCompatibilityV3 

type ClientCompatibilityV3 string
const (
	ClientCompatibilityV3WindowsServer2008   ClientCompatibilityV3 = "WINDOWS_SERVER_2008"
	ClientCompatibilityV3WindowsServer2008R2 ClientCompatibilityV3 = "WINDOWS_SERVER_2008_R2"
	ClientCompatibilityV3WindowsServer2012   ClientCompatibilityV3 = "WINDOWS_SERVER_2012"
	ClientCompatibilityV3WindowsServer2012R2 ClientCompatibilityV3 = "WINDOWS_SERVER_2012_R2"
	ClientCompatibilityV3WindowsServer2016   ClientCompatibilityV3 = "WINDOWS_SERVER_2016"
)

Enum values for ClientCompatibilityV3

func (ClientCompatibilityV3) Values 

func (ClientCompatibilityV3) Values() []ClientCompatibilityV3

Values returns all known values for ClientCompatibilityV3. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ClientCompatibilityV4 

type ClientCompatibilityV4 string
const (
	ClientCompatibilityV4WindowsServer2012   ClientCompatibilityV4 = "WINDOWS_SERVER_2012"
	ClientCompatibilityV4WindowsServer2012R2 ClientCompatibilityV4 = "WINDOWS_SERVER_2012_R2"
	ClientCompatibilityV4WindowsServer2016   ClientCompatibilityV4 = "WINDOWS_SERVER_2016"
)

Enum values for ClientCompatibilityV4

func (ClientCompatibilityV4) Values 

func (ClientCompatibilityV4) Values() []ClientCompatibilityV4

Values returns all known values for ClientCompatibilityV4. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Connector 

type Connector struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].
	//
	// [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	Arn *string

	// The Amazon Resource Name (ARN) of the certificate authority being used.
	CertificateAuthorityArn *string

	// Certificate enrollment endpoint for Active Directory domain-joined objects
	// reach out to when requesting certificates.
	CertificateEnrollmentPolicyServerEndpoint *string

	// The date and time that the connector was created.
	CreatedAt *time.Time

	// The identifier of the Active Directory.
	DirectoryId *string

	// Status of the connector. Status can be creating, active, deleting, or failed.
	Status ConnectorStatus

	// Additional information about the connector status if the status is failed.
	StatusReason ConnectorStatusReason

	// The date and time that the connector was updated.
	UpdatedAt *time.Time

	// Information of the VPC and security group(s) used with the connector.
	VpcInformation *VpcInformation
	// contains filtered or unexported fields
}

Amazon Web Services Private CA Connector for Active Directory is a service that links your Active Directory with Amazon Web Services Private CA. The connector brokers the exchange of certificates from Amazon Web Services Private CA to domain-joined users and machines managed with Active Directory.

type ConnectorStatus 

type ConnectorStatus string
const (
	ConnectorStatusCreating ConnectorStatus = "CREATING"
	ConnectorStatusActive   ConnectorStatus = "ACTIVE"
	ConnectorStatusDeleting ConnectorStatus = "DELETING"
	ConnectorStatusFailed   ConnectorStatus = "FAILED"
)

Enum values for ConnectorStatus

func (ConnectorStatus) Values 

func (ConnectorStatus) Values() []ConnectorStatus

Values returns all known values for ConnectorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConnectorStatusReason 

type ConnectorStatusReason string
const (
	ConnectorStatusReasonDirectoryAccessDenied     ConnectorStatusReason = "DIRECTORY_ACCESS_DENIED"
	ConnectorStatusReasonInternalFailure           ConnectorStatusReason = "INTERNAL_FAILURE"
	ConnectorStatusReasonPrivatecaAccessDenied     ConnectorStatusReason = "PRIVATECA_ACCESS_DENIED"
	ConnectorStatusReasonPrivatecaResourceNotFound ConnectorStatusReason = "PRIVATECA_RESOURCE_NOT_FOUND"
	ConnectorStatusReasonSecurityGroupNotInVpc     ConnectorStatusReason = "SECURITY_GROUP_NOT_IN_VPC"
	ConnectorStatusReasonVpcAccessDenied           ConnectorStatusReason = "VPC_ACCESS_DENIED"
	ConnectorStatusReasonVpcEndpointLimitExceeded  ConnectorStatusReason = "VPC_ENDPOINT_LIMIT_EXCEEDED"
	ConnectorStatusReasonVpcResourceNotFound       ConnectorStatusReason = "VPC_RESOURCE_NOT_FOUND"
)

Enum values for ConnectorStatusReason

func (ConnectorStatusReason) Values 

func (ConnectorStatusReason) Values() []ConnectorStatusReason

Values returns all known values for ConnectorStatusReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConnectorSummary 

type ConnectorSummary struct {

	//  The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].
	//
	// [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	Arn *string

	// The Amazon Resource Name (ARN) of the certificate authority being used.
	CertificateAuthorityArn *string

	// Certificate enrollment endpoint for Active Directory domain-joined objects to
	// request certificates.
	CertificateEnrollmentPolicyServerEndpoint *string

	// The date and time that the connector was created.
	CreatedAt *time.Time

	// The identifier of the Active Directory.
	DirectoryId *string

	// Status of the connector. Status can be creating, active, deleting, or failed.
	Status ConnectorStatus

	// Additional information about the connector status if the status is failed.
	StatusReason ConnectorStatusReason

	// The date and time that the connector was updated.
	UpdatedAt *time.Time

	// Information of the VPC and security group(s) used with the connector.
	VpcInformation *VpcInformation
	// contains filtered or unexported fields
}

Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services account.

type DirectoryRegistration 

type DirectoryRegistration struct {

	// The Amazon Resource Name (ARN) that was returned when you called
	// CreateDirectoryRegistration.
	Arn *string

	// The date and time that the directory registration was created.
	CreatedAt *time.Time

	// The identifier of the Active Directory.
	DirectoryId *string

	// Status of the directory registration.
	Status DirectoryRegistrationStatus

	// Additional information about the directory registration status if the status is
	// failed.
	StatusReason DirectoryRegistrationStatusReason

	// The date and time that the directory registration was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The directory registration represents the authorization of the connector service with a directory.

type DirectoryRegistrationStatus 

type DirectoryRegistrationStatus string
const (
	DirectoryRegistrationStatusCreating DirectoryRegistrationStatus = "CREATING"
	DirectoryRegistrationStatusActive   DirectoryRegistrationStatus = "ACTIVE"
	DirectoryRegistrationStatusDeleting DirectoryRegistrationStatus = "DELETING"
	DirectoryRegistrationStatusFailed   DirectoryRegistrationStatus = "FAILED"
)

Enum values for DirectoryRegistrationStatus

func (DirectoryRegistrationStatus) Values 

func (DirectoryRegistrationStatus) Values() []DirectoryRegistrationStatus

Values returns all known values for DirectoryRegistrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DirectoryRegistrationStatusReason 

type DirectoryRegistrationStatusReason string
const (
	DirectoryRegistrationStatusReasonDirectoryAccessDenied     DirectoryRegistrationStatusReason = "DIRECTORY_ACCESS_DENIED"
	DirectoryRegistrationStatusReasonDirectoryResourceNotFound DirectoryRegistrationStatusReason = "DIRECTORY_RESOURCE_NOT_FOUND"
	DirectoryRegistrationStatusReasonDirectoryNotActive        DirectoryRegistrationStatusReason = "DIRECTORY_NOT_ACTIVE"
	DirectoryRegistrationStatusReasonDirectoryNotReachable     DirectoryRegistrationStatusReason = "DIRECTORY_NOT_REACHABLE"
	DirectoryRegistrationStatusReasonDirectoryTypeNotSupported DirectoryRegistrationStatusReason = "DIRECTORY_TYPE_NOT_SUPPORTED"
	DirectoryRegistrationStatusReasonInternalFailure           DirectoryRegistrationStatusReason = "INTERNAL_FAILURE"
)

Enum values for DirectoryRegistrationStatusReason

func (DirectoryRegistrationStatusReason) Values 

func (DirectoryRegistrationStatusReason) Values() []DirectoryRegistrationStatusReason

Values returns all known values for DirectoryRegistrationStatusReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DirectoryRegistrationSummary 

type DirectoryRegistrationSummary struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration].
	//
	// [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
	Arn *string

	// The date and time that the directory registration was created.
	CreatedAt *time.Time

	// The identifier of the Active Directory.
	DirectoryId *string

	// Status of the directory registration.
	Status DirectoryRegistrationStatus

	// Additional information about the directory registration status if the status is
	// failed.
	StatusReason DirectoryRegistrationStatusReason

	// The date and time that the directory registration was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The directory registration represents the authorization of the connector service with the Active Directory.

type EnrollmentFlagsV2 

type EnrollmentFlagsV2 struct {

	// Allow renewal using the same key.
	EnableKeyReuseOnNtTokenKeysetStorageFull *bool

	// Include symmetric algorithms allowed by the subject.
	IncludeSymmetricAlgorithms *bool

	// This flag instructs the CA to not include the security extension
	// szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE]
	// sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This
	// addresses a Windows Kerberos elevation-of-privilege vulnerability.
	NoSecurityExtension *bool

	// Delete expired or revoked certificates instead of archiving them.
	RemoveInvalidCertificateFromPersonalStore *bool

	// Require user interaction when the subject is enrolled and the private key
	// associated with the certificate is used.
	UserInteractionRequired *bool
	// contains filtered or unexported fields
}

Template configurations for v2 template schema.

type EnrollmentFlagsV3 

type EnrollmentFlagsV3 struct {

	// Allow renewal using the same key.
	EnableKeyReuseOnNtTokenKeysetStorageFull *bool

	// Include symmetric algorithms allowed by the subject.
	IncludeSymmetricAlgorithms *bool

	// This flag instructs the CA to not include the security extension
	// szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE]
	// sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This
	// addresses a Windows Kerberos elevation-of-privilege vulnerability.
	NoSecurityExtension *bool

	// Delete expired or revoked certificates instead of archiving them.
	RemoveInvalidCertificateFromPersonalStore *bool

	// Require user interaction when the subject is enrolled and the private key
	// associated with the certificate is used.
	UserInteractionRequired *bool
	// contains filtered or unexported fields
}

Template configurations for v3 template schema.

type EnrollmentFlagsV4 

type EnrollmentFlagsV4 struct {

	// Allow renewal using the same key.
	EnableKeyReuseOnNtTokenKeysetStorageFull *bool

	// Include symmetric algorithms allowed by the subject.
	IncludeSymmetricAlgorithms *bool

	// This flag instructs the CA to not include the security extension
	// szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE]
	// sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This
	// addresses a Windows Kerberos elevation-of-privilege vulnerability.
	NoSecurityExtension *bool

	// Delete expired or revoked certificates instead of archiving them.
	RemoveInvalidCertificateFromPersonalStore *bool

	// Require user interaction when the subject is enrolled and the private key
	// associated with the certificate is used.
	UserInteractionRequired *bool
	// contains filtered or unexported fields
}

Template configurations for v4 template schema.

type ExtensionsV2 

type ExtensionsV2 struct {

	// The key usage extension defines the purpose (e.g., encipherment, signature,
	// certificate signing) of the key contained in the certificate.
	//
	// This member is required.
	KeyUsage *KeyUsage

	// Application policies specify what the certificate is used for and its purpose.
	ApplicationPolicies *ApplicationPolicies
	// contains filtered or unexported fields
}

Certificate extensions for v2 template schema

type ExtensionsV3 

type ExtensionsV3 struct {

	// The key usage extension defines the purpose (e.g., encipherment, signature,
	// certificate signing) of the key contained in the certificate.
	//
	// This member is required.
	KeyUsage *KeyUsage

	// Application policies specify what the certificate is used for and its purpose.
	ApplicationPolicies *ApplicationPolicies
	// contains filtered or unexported fields
}

Certificate extensions for v3 template schema

type ExtensionsV4 

type ExtensionsV4 struct {

	// The key usage extension defines the purpose (e.g., encipherment, signature) of
	// the key contained in the certificate.
	//
	// This member is required.
	KeyUsage *KeyUsage

	// Application policies specify what the certificate is used for and its purpose.
	ApplicationPolicies *ApplicationPolicies
	// contains filtered or unexported fields
}

Certificate extensions for v4 template schema

type GeneralFlagsV2 

type GeneralFlagsV2 struct {

	// Allows certificate issuance using autoenrollment. Set to TRUE to allow
	// autoenrollment.
	AutoEnrollment *bool

	// Defines if the template is for machines or users. Set to TRUE if the template
	// is for machines. Set to FALSE if the template is for users.
	MachineType *bool
	// contains filtered or unexported fields
}

General flags for v2 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.

type GeneralFlagsV3 

type GeneralFlagsV3 struct {

	// Allows certificate issuance using autoenrollment. Set to TRUE to allow
	// autoenrollment.
	AutoEnrollment *bool

	// Defines if the template is for machines or users. Set to TRUE if the template
	// is for machines. Set to FALSE if the template is for users
	MachineType *bool
	// contains filtered or unexported fields
}

General flags for v3 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.

type GeneralFlagsV4 

type GeneralFlagsV4 struct {

	// Allows certificate issuance using autoenrollment. Set to TRUE to allow
	// autoenrollment.
	AutoEnrollment *bool

	// Defines if the template is for machines or users. Set to TRUE if the template
	// is for machines. Set to FALSE if the template is for users
	MachineType *bool
	// contains filtered or unexported fields
}

General flags for v4 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.

type HashAlgorithm 

type HashAlgorithm string
const (
	HashAlgorithmSha256 HashAlgorithm = "SHA256"
	HashAlgorithmSha384 HashAlgorithm = "SHA384"
	HashAlgorithmSha512 HashAlgorithm = "SHA512"
)

Enum values for HashAlgorithm

func (HashAlgorithm) Values 

func (HashAlgorithm) Values() []HashAlgorithm

Values returns all known values for HashAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure with an internal server.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type KeySpec 

type KeySpec string
const (
	KeySpecKeyExchange KeySpec = "KEY_EXCHANGE"
	KeySpecSignature   KeySpec = "SIGNATURE"
)

Enum values for KeySpec

func (KeySpec) Values 

func (KeySpec) Values() []KeySpec

Values returns all known values for KeySpec. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KeyUsage 

type KeyUsage struct {

	// The key usage flags represent the purpose (e.g., encipherment, signature) of
	// the key contained in the certificate.
	//
	// This member is required.
	UsageFlags *KeyUsageFlags

	// Sets the key usage extension to critical.
	Critical *bool
	// contains filtered or unexported fields
}

The key usage extension defines the purpose (e.g., encipherment, signature) of the key contained in the certificate.

type KeyUsageFlags 

type KeyUsageFlags struct {

	// DataEncipherment is asserted when the subject public key is used for directly
	// enciphering raw user data without the use of an intermediate symmetric cipher.
	DataEncipherment *bool

	// The digitalSignature is asserted when the subject public key is used for
	// verifying digital signatures.
	DigitalSignature *bool

	// KeyAgreement is asserted when the subject public key is used for key agreement.
	KeyAgreement *bool

	// KeyEncipherment is asserted when the subject public key is used for enciphering
	// private or secret keys, i.e., for key transport.
	KeyEncipherment *bool

	// NonRepudiation is asserted when the subject public key is used to verify
	// digital signatures.
	NonRepudiation *bool
	// contains filtered or unexported fields
}

The key usage flags represent the purpose (e.g., encipherment, signature) of the key contained in the certificate.

type KeyUsageProperty 

type KeyUsageProperty interface {
	// contains filtered or unexported methods
}

The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.

The following types satisfy this interface: 

KeyUsagePropertyMemberPropertyFlags
KeyUsagePropertyMemberPropertyType
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/pcaconnectorad/types"
)

func main() {
	var union types.KeyUsageProperty
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.KeyUsagePropertyMemberPropertyFlags:
		_ = v.Value // Value is types.KeyUsagePropertyFlags

	case *types.KeyUsagePropertyMemberPropertyType:
		_ = v.Value // Value is types.KeyUsagePropertyType

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type KeyUsagePropertyFlags 

type KeyUsagePropertyFlags struct {

	// Allows key for encryption and decryption.
	Decrypt *bool

	// Allows key exchange without encryption.
	KeyAgreement *bool

	// Allow key use for digital signature.
	Sign *bool
	// contains filtered or unexported fields
}

Specifies key usage.

type KeyUsagePropertyMemberPropertyFlags 

type KeyUsagePropertyMemberPropertyFlags struct {
	Value KeyUsagePropertyFlags
	// contains filtered or unexported fields
}

You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

type KeyUsagePropertyMemberPropertyType 

type KeyUsagePropertyMemberPropertyType struct {
	Value KeyUsagePropertyType
	// contains filtered or unexported fields
}

You can specify all key usages using property type ALL. You can use property type or property flags but not both.

type KeyUsagePropertyType 

type KeyUsagePropertyType string
const (
	KeyUsagePropertyTypeAll KeyUsagePropertyType = "ALL"
)

Enum values for KeyUsagePropertyType

func (KeyUsagePropertyType) Values 

func (KeyUsagePropertyType) Values() []KeyUsagePropertyType

Values returns all known values for KeyUsagePropertyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PrivateKeyAlgorithm 

type PrivateKeyAlgorithm string
const (
	PrivateKeyAlgorithmRsa      PrivateKeyAlgorithm = "RSA"
	PrivateKeyAlgorithmEcdhP256 PrivateKeyAlgorithm = "ECDH_P256"
	PrivateKeyAlgorithmEcdhP384 PrivateKeyAlgorithm = "ECDH_P384"
	PrivateKeyAlgorithmEcdhP521 PrivateKeyAlgorithm = "ECDH_P521"
)

Enum values for PrivateKeyAlgorithm

func (PrivateKeyAlgorithm) Values 

func (PrivateKeyAlgorithm) Values() []PrivateKeyAlgorithm

Values returns all known values for PrivateKeyAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PrivateKeyAttributesV2 

type PrivateKeyAttributesV2 struct {

	// Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
	// value.
	//
	// This member is required.
	KeySpec KeySpec

	// Set the minimum key length of the private key.
	//
	// This member is required.
	MinimalKeyLength *int32

	// Defines the cryptographic providers used to generate the private key.
	CryptoProviders []string
	// contains filtered or unexported fields
}

Defines the attributes of the private key.

type PrivateKeyAttributesV3 

type PrivateKeyAttributesV3 struct {

	// Defines the algorithm used to generate the private key.
	//
	// This member is required.
	Algorithm PrivateKeyAlgorithm

	// Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
	// value.
	//
	// This member is required.
	KeySpec KeySpec

	// The key usage property defines the purpose of the private key contained in the
	// certificate. You can specify specific purposes using property flags or all by
	// using property type ALL.
	//
	// This member is required.
	KeyUsageProperty KeyUsageProperty

	// Set the minimum key length of the private key.
	//
	// This member is required.
	MinimalKeyLength *int32

	// Defines the cryptographic providers used to generate the private key.
	CryptoProviders []string
	// contains filtered or unexported fields
}

Defines the attributes of the private key.

type PrivateKeyAttributesV4 

type PrivateKeyAttributesV4 struct {

	// Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
	// value.
	//
	// This member is required.
	KeySpec KeySpec

	// Set the minimum key length of the private key.
	//
	// This member is required.
	MinimalKeyLength *int32

	// Defines the algorithm used to generate the private key.
	Algorithm PrivateKeyAlgorithm

	// Defines the cryptographic providers used to generate the private key.
	CryptoProviders []string

	// The key usage property defines the purpose of the private key contained in the
	// certificate. You can specify specific purposes using property flags or all by
	// using property type ALL.
	KeyUsageProperty KeyUsageProperty
	// contains filtered or unexported fields
}

Defines the attributes of the private key.

type PrivateKeyFlagsV2 

type PrivateKeyFlagsV2 struct {

	// Defines the minimum client compatibility.
	//
	// This member is required.
	ClientVersion ClientCompatibilityV2

	// Allows the private key to be exported.
	ExportableKey *bool

	// Require user input when using the private key for enrollment.
	StrongKeyProtectionRequired *bool
	// contains filtered or unexported fields
}

Private key flags for v2 templates specify the client compatibility, if the private key can be exported, and if user input is required when using a private key.

type PrivateKeyFlagsV3 

type PrivateKeyFlagsV3 struct {

	// Defines the minimum client compatibility.
	//
	// This member is required.
	ClientVersion ClientCompatibilityV3

	// Allows the private key to be exported.
	ExportableKey *bool

	// Reguires the PKCS #1 v2.1 signature format for certificates. You should verify
	// that your CA, objects, and applications can accept this signature format.
	RequireAlternateSignatureAlgorithm *bool

	// Requirer user input when using the private key for enrollment.
	StrongKeyProtectionRequired *bool
	// contains filtered or unexported fields
}

Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.

type PrivateKeyFlagsV4 

type PrivateKeyFlagsV4 struct {

	// Defines the minimum client compatibility.
	//
	// This member is required.
	ClientVersion ClientCompatibilityV4

	// Allows the private key to be exported.
	ExportableKey *bool

	// Requires the PKCS #1 v2.1 signature format for certificates. You should verify
	// that your CA, objects, and applications can accept this signature format.
	RequireAlternateSignatureAlgorithm *bool

	// Renew certificate using the same private key.
	RequireSameKeyRenewal *bool

	// Require user input when using the private key for enrollment.
	StrongKeyProtectionRequired *bool

	// Specifies the cryptographic service provider category used to generate private
	// keys. Set to TRUE to use Legacy Cryptographic Service Providers and FALSE to use
	// Key Storage Providers.
	UseLegacyProvider *bool
	// contains filtered or unexported fields
}

Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServicePrincipalName 

type ServicePrincipalName struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateConnector.html].
	//
	// [CreateConnector.html]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	ConnectorArn *string

	// The date and time that the service principal name was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration].
	//
	// [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
	DirectoryRegistrationArn *string

	// The status of a service principal name.
	Status ServicePrincipalNameStatus

	// Additional information for the status of a service principal name if the status
	// is failed.
	StatusReason ServicePrincipalNameStatusReason

	// The date and time that the service principal name was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The service principal name that the connector uses to authenticate with Active Directory.

type ServicePrincipalNameStatus 

type ServicePrincipalNameStatus string
const (
	ServicePrincipalNameStatusCreating ServicePrincipalNameStatus = "CREATING"
	ServicePrincipalNameStatusActive   ServicePrincipalNameStatus = "ACTIVE"
	ServicePrincipalNameStatusDeleting ServicePrincipalNameStatus = "DELETING"
	ServicePrincipalNameStatusFailed   ServicePrincipalNameStatus = "FAILED"
)

Enum values for ServicePrincipalNameStatus

func (ServicePrincipalNameStatus) Values 

func (ServicePrincipalNameStatus) Values() []ServicePrincipalNameStatus

Values returns all known values for ServicePrincipalNameStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServicePrincipalNameStatusReason 

type ServicePrincipalNameStatusReason string
const (
	ServicePrincipalNameStatusReasonDirectoryAccessDenied        ServicePrincipalNameStatusReason = "DIRECTORY_ACCESS_DENIED"
	ServicePrincipalNameStatusReasonDirectoryNotReachable        ServicePrincipalNameStatusReason = "DIRECTORY_NOT_REACHABLE"
	ServicePrincipalNameStatusReasonDirectoryResourceNotFound    ServicePrincipalNameStatusReason = "DIRECTORY_RESOURCE_NOT_FOUND"
	ServicePrincipalNameStatusReasonSpnExistsOnDifferentAdObject ServicePrincipalNameStatusReason = "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT"
	ServicePrincipalNameStatusReasonInternalFailure              ServicePrincipalNameStatusReason = "INTERNAL_FAILURE"
)

Enum values for ServicePrincipalNameStatusReason

func (ServicePrincipalNameStatusReason) Values 

func (ServicePrincipalNameStatusReason) Values() []ServicePrincipalNameStatusReason

Values returns all known values for ServicePrincipalNameStatusReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServicePrincipalNameSummary 

type ServicePrincipalNameSummary struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].
	//
	// [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	ConnectorArn *string

	// The date and time that the service principal name was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration].
	//
	// [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html
	DirectoryRegistrationArn *string

	// The status of a service principal name.
	Status ServicePrincipalNameStatus

	// Additional information for the status of a service principal name if the status
	// is failed.
	StatusReason ServicePrincipalNameStatusReason

	// Time when the service principal name was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The service principal name that the connector uses to authenticate with Active Directory.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

Request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SubjectNameFlagsV2 

type SubjectNameFlagsV2 struct {

	// Include the common name in the subject name.
	RequireCommonName *bool

	// Include the directory path in the subject name.
	RequireDirectoryPath *bool

	// Include the DNS as common name in the subject name.
	RequireDnsAsCn *bool

	// Include the subject's email in the subject name.
	RequireEmail *bool

	// Include the globally unique identifier (GUID) in the subject alternate name.
	SanRequireDirectoryGuid *bool

	// Include the DNS in the subject alternate name.
	SanRequireDns *bool

	// Include the domain DNS in the subject alternate name.
	SanRequireDomainDns *bool

	// Include the subject's email in the subject alternate name.
	SanRequireEmail *bool

	// Include the service principal name (SPN) in the subject alternate name.
	SanRequireSpn *bool

	// Include the user principal name (UPN) in the subject alternate name.
	SanRequireUpn *bool
	// contains filtered or unexported fields
}

Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.

type SubjectNameFlagsV3 

type SubjectNameFlagsV3 struct {

	// Include the common name in the subject name.
	RequireCommonName *bool

	// Include the directory path in the subject name.
	RequireDirectoryPath *bool

	// Include the DNS as common name in the subject name.
	RequireDnsAsCn *bool

	// Include the subject's email in the subject name.
	RequireEmail *bool

	// Include the globally unique identifier (GUID) in the subject alternate name.
	SanRequireDirectoryGuid *bool

	// Include the DNS in the subject alternate name.
	SanRequireDns *bool

	// Include the domain DNS in the subject alternate name.
	SanRequireDomainDns *bool

	// Include the subject's email in the subject alternate name.
	SanRequireEmail *bool

	// Include the service principal name (SPN) in the subject alternate name.
	SanRequireSpn *bool

	// Include the user principal name (UPN) in the subject alternate name.
	SanRequireUpn *bool
	// contains filtered or unexported fields
}

Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.

type SubjectNameFlagsV4 

type SubjectNameFlagsV4 struct {

	// Include the common name in the subject name.
	RequireCommonName *bool

	// Include the directory path in the subject name.
	RequireDirectoryPath *bool

	// Include the DNS as common name in the subject name.
	RequireDnsAsCn *bool

	// Include the subject's email in the subject name.
	RequireEmail *bool

	// Include the globally unique identifier (GUID) in the subject alternate name.
	SanRequireDirectoryGuid *bool

	// Include the DNS in the subject alternate name.
	SanRequireDns *bool

	// Include the domain DNS in the subject alternate name.
	SanRequireDomainDns *bool

	// Include the subject's email in the subject alternate name.
	SanRequireEmail *bool

	// Include the service principal name (SPN) in the subject alternate name.
	SanRequireSpn *bool

	// Include the user principal name (UPN) in the subject alternate name.
	SanRequireUpn *bool
	// contains filtered or unexported fields
}

Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.

type Template 

type Template struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
	Arn *string

	//  The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].
	//
	// [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	ConnectorArn *string

	// The date and time that the template was created.
	CreatedAt *time.Time

	// Template configuration to define the information included in certificates.
	// Define certificate validity and renewal periods, certificate request handling
	// and enrollment options, key usage extensions, application policies, and
	// cryptography settings.
	Definition TemplateDefinition

	// Name of the templates. Template names must be unique.
	Name *string

	// Object identifier of a template.
	ObjectIdentifier *string

	// The template schema version. Template schema versions can be v2, v3, or v4. The
	// template configuration options change based on the template schema version.
	PolicySchema *int32

	// The version of the template. Template updates will increment the minor
	// revision. Re-enrolling all certificate holders will increment the major
	// revision.
	Revision *TemplateRevision

	// Status of the template. Status can be creating, active, deleting, or failed.
	Status TemplateStatus

	// The date and time that the template was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership.

type TemplateDefinition 

type TemplateDefinition interface {
	// contains filtered or unexported methods
}

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

The following types satisfy this interface: 

TemplateDefinitionMemberTemplateV2
TemplateDefinitionMemberTemplateV3
TemplateDefinitionMemberTemplateV4
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/pcaconnectorad/types"
)

func main() {
	var union types.TemplateDefinition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TemplateDefinitionMemberTemplateV2:
		_ = v.Value // Value is types.TemplateV2

	case *types.TemplateDefinitionMemberTemplateV3:
		_ = v.Value // Value is types.TemplateV3

	case *types.TemplateDefinitionMemberTemplateV4:
		_ = v.Value // Value is types.TemplateV4

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type TemplateDefinitionMemberTemplateV2 

type TemplateDefinitionMemberTemplateV2 struct {
	Value TemplateV2
	// contains filtered or unexported fields
}

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

type TemplateDefinitionMemberTemplateV3 

type TemplateDefinitionMemberTemplateV3 struct {
	Value TemplateV3
	// contains filtered or unexported fields
}

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

type TemplateDefinitionMemberTemplateV4 

type TemplateDefinitionMemberTemplateV4 struct {
	Value TemplateV4
	// contains filtered or unexported fields
}

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

type TemplateRevision 

type TemplateRevision struct {

	// The revision version of the template. Re-enrolling all certificate holders will
	// increment the major revision.
	//
	// This member is required.
	MajorRevision *int32

	// The revision version of the template. Re-enrolling all certificate holders will
	// increment the major revision.
	//
	// This member is required.
	MinorRevision *int32
	// contains filtered or unexported fields
}

The revision version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.

type TemplateStatus 

type TemplateStatus string
const (
	TemplateStatusActive   TemplateStatus = "ACTIVE"
	TemplateStatusDeleting TemplateStatus = "DELETING"
)

Enum values for TemplateStatus

func (TemplateStatus) Values 

func (TemplateStatus) Values() []TemplateStatus

Values returns all known values for TemplateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateSummary 

type TemplateSummary struct {

	// The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].
	//
	// [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html
	Arn *string

	//  The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].
	//
	// [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html
	ConnectorArn *string

	// The date and time that the template was created.
	CreatedAt *time.Time

	// Template configuration to define the information included in certificates.
	// Define certificate validity and renewal periods, certificate request handling
	// and enrollment options, key usage extensions, application policies, and
	// cryptography settings.
	Definition TemplateDefinition

	// Name of the template. The template name must be unique.
	Name *string

	// Object identifier of a template.
	ObjectIdentifier *string

	// The template schema version. Template schema versions can be v2, v3, or v4. The
	// template configuration options change based on the template schema version.
	PolicySchema *int32

	// The revision version of the template. Template updates will increment the minor
	// revision. Re-enrolling all certificate holders will increment the major
	// revision.
	Revision *TemplateRevision

	// Status of the template. Status can be creating, active, deleting, or failed.
	Status TemplateStatus

	// The date and time that the template was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership.

type TemplateV2 

type TemplateV2 struct {

	// Certificate validity describes the validity and renewal periods of a
	// certificate.
	//
	// This member is required.
	CertificateValidity *CertificateValidity

	// Enrollment flags describe the enrollment settings for certificates such as
	// using the existing private key and deleting expired or revoked certificates.
	//
	// This member is required.
	EnrollmentFlags *EnrollmentFlagsV2

	// Extensions describe the key usage extensions and application policies for a
	// template.
	//
	// This member is required.
	Extensions *ExtensionsV2

	// General flags describe whether the template is used for computers or users and
	// if the template can be used with autoenrollment.
	//
	// This member is required.
	GeneralFlags *GeneralFlagsV2

	// Private key attributes allow you to specify the minimal key length, key spec,
	// and cryptographic providers for the private key of a certificate for v2
	// templates. V2 templates allow you to use Legacy Cryptographic Service Providers.
	//
	// This member is required.
	PrivateKeyAttributes *PrivateKeyAttributesV2

	// Private key flags for v2 templates specify the client compatibility, if the
	// private key can be exported, and if user input is required when using a private
	// key.
	//
	// This member is required.
	PrivateKeyFlags *PrivateKeyFlagsV2

	// Subject name flags describe the subject name and subject alternate name that is
	// included in a certificate.
	//
	// This member is required.
	SubjectNameFlags *SubjectNameFlagsV2

	// List of templates in Active Directory that are superseded by this template.
	SupersededTemplates []string
	// contains filtered or unexported fields
}

v2 template schema that uses Legacy Cryptographic Providers.

type TemplateV3 

type TemplateV3 struct {

	// Certificate validity describes the validity and renewal periods of a
	// certificate.
	//
	// This member is required.
	CertificateValidity *CertificateValidity

	// Enrollment flags describe the enrollment settings for certificates such as
	// using the existing private key and deleting expired or revoked certificates.
	//
	// This member is required.
	EnrollmentFlags *EnrollmentFlagsV3

	// Extensions describe the key usage extensions and application policies for a
	// template.
	//
	// This member is required.
	Extensions *ExtensionsV3

	// General flags describe whether the template is used for computers or users and
	// if the template can be used with autoenrollment.
	//
	// This member is required.
	GeneralFlags *GeneralFlagsV3

	// Specifies the hash algorithm used to hash the private key.
	//
	// This member is required.
	HashAlgorithm HashAlgorithm

	// Private key attributes allow you to specify the algorithm, minimal key length,
	// key spec, key usage, and cryptographic providers for the private key of a
	// certificate for v3 templates. V3 templates allow you to use Key Storage
	// Providers.
	//
	// This member is required.
	PrivateKeyAttributes *PrivateKeyAttributesV3

	// Private key flags for v3 templates specify the client compatibility, if the
	// private key can be exported, if user input is required when using a private key,
	// and if an alternate signature algorithm should be used.
	//
	// This member is required.
	PrivateKeyFlags *PrivateKeyFlagsV3

	// Subject name flags describe the subject name and subject alternate name that is
	// included in a certificate.
	//
	// This member is required.
	SubjectNameFlags *SubjectNameFlagsV3

	// List of templates in Active Directory that are superseded by this template.
	SupersededTemplates []string
	// contains filtered or unexported fields
}

v3 template schema that uses Key Storage Providers.

type TemplateV4 

type TemplateV4 struct {

	// Certificate validity describes the validity and renewal periods of a
	// certificate.
	//
	// This member is required.
	CertificateValidity *CertificateValidity

	// Enrollment flags describe the enrollment settings for certificates using the
	// existing private key and deleting expired or revoked certificates.
	//
	// This member is required.
	EnrollmentFlags *EnrollmentFlagsV4

	// Extensions describe the key usage extensions and application policies for a
	// template.
	//
	// This member is required.
	Extensions *ExtensionsV4

	// General flags describe whether the template is used for computers or users and
	// if the template can be used with autoenrollment.
	//
	// This member is required.
	GeneralFlags *GeneralFlagsV4

	// Private key attributes allow you to specify the minimal key length, key spec,
	// key usage, and cryptographic providers for the private key of a certificate for
	// v4 templates. V4 templates allow you to use either Key Storage Providers or
	// Legacy Cryptographic Service Providers. You specify the cryptography provider
	// category in private key flags.
	//
	// This member is required.
	PrivateKeyAttributes *PrivateKeyAttributesV4

	// Private key flags for v4 templates specify the client compatibility, if the
	// private key can be exported, if user input is required when using a private key,
	// if an alternate signature algorithm should be used, and if certificates are
	// renewed using the same private key.
	//
	// This member is required.
	PrivateKeyFlags *PrivateKeyFlagsV4

	// Subject name flags describe the subject name and subject alternate name that is
	// included in a certificate.
	//
	// This member is required.
	SubjectNameFlags *SubjectNameFlagsV4

	// Specifies the hash algorithm used to hash the private key. Hash algorithm can
	// only be specified when using Key Storage Providers.
	HashAlgorithm HashAlgorithm

	// List of templates in Active Directory that are superseded by this template.
	SupersededTemplates []string
	// contains filtered or unexported fields
}

v4 template schema that can use either Legacy Cryptographic Providers or Key Storage Providers.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode *string
	QuotaCode   *string
	// contains filtered or unexported fields
}

The limit on the number of requests per second was exceeded.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	// contains filtered or unexported fields
}

An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonInvalidPermission     ValidationExceptionReason = "INVALID_PERMISSION"
	ValidationExceptionReasonInvalidState          ValidationExceptionReason = "INVALID_STATE"
	ValidationExceptionReasonMismatchedConnector   ValidationExceptionReason = "MISMATCHED_CONNECTOR"
	ValidationExceptionReasonMismatchedVpc         ValidationExceptionReason = "MISMATCHED_VPC"
	ValidationExceptionReasonNoClientToken         ValidationExceptionReason = "NO_CLIENT_TOKEN"
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidityPeriod 

type ValidityPeriod struct {

	// The numeric value for the validity period.
	//
	// This member is required.
	Period *int64

	// The unit of time. You can select hours, days, weeks, months, and years.
	//
	// This member is required.
	PeriodType ValidityPeriodType
	// contains filtered or unexported fields
}

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in hours, days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

type ValidityPeriodType 

type ValidityPeriodType string
const (
	ValidityPeriodTypeHours  ValidityPeriodType = "HOURS"
	ValidityPeriodTypeDays   ValidityPeriodType = "DAYS"
	ValidityPeriodTypeWeeks  ValidityPeriodType = "WEEKS"
	ValidityPeriodTypeMonths ValidityPeriodType = "MONTHS"
	ValidityPeriodTypeYears  ValidityPeriodType = "YEARS"
)

Enum values for ValidityPeriodType

func (ValidityPeriodType) Values 

func (ValidityPeriodType) Values() []ValidityPeriodType

Values returns all known values for ValidityPeriodType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcInformation 

type VpcInformation struct {

	// The security groups used with the connector. You can use a maximum of 4
	// security groups with a connector.
	//
	// This member is required.
	SecurityGroupIds []string
	// contains filtered or unexported fields
}

Information about your VPC and security groups used with the connector.

Source Files

View all Source files

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.