Skip to content

Latest commit

 

History

History
250 lines (216 loc) · 8.64 KB

types.md

File metadata and controls

250 lines (216 loc) · 8.64 KB
Raw

AWS.ACMPCA @ default

Resource AWS.ACMPCA/Certificate@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.ACMPCA/CertificateProperties (Required): properties of the resource

Resource AWS.ACMPCA/CertificateAuthority@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.ACMPCA/CertificateAuthorityActivation@default

  • Valid Scope(s): Unknown

Properties

AWS.ACMPCA/CertificateProperties

Properties

  • ApiPassthrough: ApiPassthrough (WriteOnly): These are fields to be overridden in a certificate at the time of issuance. These requires an API_Passthrough template be used or they will be ignored.
  • Arn: string (ReadOnly, Identifier): The ARN of the issued certificate.
  • Certificate: string (ReadOnly): The issued certificate in base 64 PEM-encoded format.
  • CertificateAuthorityArn: string (Required, Identifier): The Amazon Resource Name (ARN) for the private CA to issue the certificate.
  • CertificateSigningRequest: string (Required, WriteOnly): The certificate signing request (CSR) for the Certificate.
  • SigningAlgorithm: string (Required): The name of the algorithm that will be used to sign the Certificate.
  • TemplateArn: string: Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.
  • Validity: Validity (Required): The time before which the Certificate will be valid.
  • ValidityNotBefore: Validity: The time after which the Certificate will be valid.

ApiPassthrough

Properties

Extensions

Properties

PolicyInformation

Properties

PolicyQualifierInfo

Properties

  • PolicyQualifierId: string (Required)
  • Qualifier: Qualifier (Required)

Qualifier

Properties

  • CpsUri: string (Required)

CustomExtension

Properties

  • Critical: bool
  • ObjectIdentifier: string (Required)
  • Value: string (Required)

ExtendedKeyUsage

Properties

  • ExtendedKeyUsageObjectIdentifier: string
  • ExtendedKeyUsageType: string

KeyUsage

Properties

  • CRLSign: bool
  • DataEncipherment: bool
  • DecipherOnly: bool
  • DigitalSignature: bool
  • EncipherOnly: bool
  • KeyAgreement: bool
  • KeyCertSign: bool
  • KeyEncipherment: bool
  • NonRepudiation: bool

GeneralName

Properties

  • DirectoryName: Subject
  • DnsName: string
  • EdiPartyName: EdiPartyName
  • IpAddress: string
  • OtherName: OtherName
  • RegisteredId: string
  • Rfc822Name: string
  • UniformResourceIdentifier: string

Subject

Properties

  • CommonName: string
  • Country: string
  • CustomAttributes: CustomAttribute[]
  • DistinguishedNameQualifier: string
  • GenerationQualifier: string
  • GivenName: string
  • Initials: string
  • Locality: string
  • Organization: string
  • OrganizationalUnit: string
  • Pseudonym: string
  • SerialNumber: string
  • State: string
  • Surname: string
  • Title: string

CustomAttribute

Properties

  • ObjectIdentifier: string (Required)
  • Value: string (Required)

EdiPartyName

Properties

  • NameAssigner: string (Required)
  • PartyName: string (Required)

OtherName

Properties

  • TypeId: string (Required)
  • Value: string (Required)

Validity

Properties

  • Type: string (Required)
  • Value: int (Required)

AWS.ACMPCA/CertificateAuthorityProperties

Properties

  • Arn: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the certificate authority.
  • CertificateSigningRequest: string (ReadOnly): The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
  • CsrExtensions: CsrExtensions: Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
  • KeyAlgorithm: string (Required): Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
  • KeyStorageSecurityStandard: string: KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
  • RevocationConfiguration: RevocationConfiguration: Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
  • SigningAlgorithm: string (Required): Algorithm your CA uses to sign certificate requests.
  • Subject: Subject (Required, WriteOnly): Structure that contains X.500 distinguished name information for your CA.
  • Tags: Tag[]
  • Type: string (Required): The type of the certificate authority.
  • UsageMode: string: Usage mode of the ceritificate authority.

CsrExtensions

Properties

KeyUsage

Properties

  • CRLSign: bool
  • DataEncipherment: bool
  • DecipherOnly: bool
  • DigitalSignature: bool
  • EncipherOnly: bool
  • KeyAgreement: bool
  • KeyCertSign: bool
  • KeyEncipherment: bool
  • NonRepudiation: bool

AccessDescription

Properties

GeneralName

Properties

  • DirectoryName: Subject
  • DnsName: string
  • EdiPartyName: EdiPartyName
  • IpAddress: string
  • OtherName: OtherName
  • RegisteredId: string
  • Rfc822Name: string
  • UniformResourceIdentifier: string

Subject

Properties

  • CommonName: string
  • Country: string
  • CustomAttributes: CustomAttribute[]
  • DistinguishedNameQualifier: string
  • GenerationQualifier: string
  • GivenName: string
  • Initials: string
  • Locality: string
  • Organization: string
  • OrganizationalUnit: string
  • Pseudonym: string
  • SerialNumber: string
  • State: string
  • Surname: string
  • Title: string

CustomAttribute

Properties

  • ObjectIdentifier: string (Required)
  • Value: string (Required)

EdiPartyName

Properties

  • NameAssigner: string (Required)
  • PartyName: string (Required)

OtherName

Properties

  • TypeId: string (Required)
  • Value: string (Required)

AccessMethod

Properties

  • AccessMethodType: string
  • CustomObjectIdentifier: string

RevocationConfiguration

Properties

CrlConfiguration

Properties

  • CustomCname: string
  • Enabled: bool
  • ExpirationInDays: int
  • S3BucketName: string
  • S3ObjectAcl: string

OcspConfiguration

Properties

  • Enabled: bool
  • OcspCustomCname: string

Tag

Properties

  • Key: string
  • Value: string

AWS.ACMPCA/CertificateAuthorityActivationProperties

Properties

  • Certificate: string (Required, WriteOnly): Certificate Authority certificate that will be installed in the Certificate Authority.
  • CertificateAuthorityArn: string (Required, Identifier): Arn of the Certificate Authority.
  • CertificateChain: string (WriteOnly): Certificate chain for the Certificate Authority certificate.
  • CompleteCertificateChain: string (ReadOnly): The complete certificate chain, including the Certificate Authority certificate.
  • Status: string: The status of the Certificate Authority.