Documentation ¶
Index ¶
- func CfnCertificateAuthorityActivation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificateAuthorityActivation_IsCfnElement(x interface{}) *bool
- func CfnCertificateAuthorityActivation_IsCfnResource(x interface{}) *bool
- func CfnCertificateAuthorityActivation_IsConstruct(x interface{}) *bool
- func CfnCertificateAuthority_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificateAuthority_IsCfnElement(x interface{}) *bool
- func CfnCertificateAuthority_IsCfnResource(x interface{}) *bool
- func CfnCertificateAuthority_IsConstruct(x interface{}) *bool
- func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificate_IsCfnElement(x interface{}) *bool
- func CfnCertificate_IsCfnResource(x interface{}) *bool
- func CfnCertificate_IsConstruct(x interface{}) *bool
- func CfnPermission_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPermission_IsCfnElement(x interface{}) *bool
- func CfnPermission_IsCfnResource(x interface{}) *bool
- func CfnPermission_IsConstruct(x interface{}) *bool
- func NewCfnCertificateAuthorityActivation_Override(c CfnCertificateAuthorityActivation, scope constructs.Construct, id *string, ...)
- func NewCfnCertificateAuthority_Override(c CfnCertificateAuthority, scope constructs.Construct, id *string, ...)
- func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnPermission_Override(c CfnPermission, scope constructs.Construct, id *string, ...)
- type CertificateAuthority
- type CfnCertificate
- type CfnCertificateAuthority
- type CfnCertificateAuthorityActivation
- type CfnCertificateAuthorityActivationProps
- type CfnCertificateAuthorityProps
- type CfnCertificateAuthority_AccessDescriptionProperty
- type CfnCertificateAuthority_AccessMethodProperty
- type CfnCertificateAuthority_CrlConfigurationProperty
- type CfnCertificateAuthority_CsrExtensionsProperty
- type CfnCertificateAuthority_CustomAttributeProperty
- type CfnCertificateAuthority_EdiPartyNameProperty
- type CfnCertificateAuthority_GeneralNameProperty
- type CfnCertificateAuthority_KeyUsageProperty
- type CfnCertificateAuthority_OcspConfigurationProperty
- type CfnCertificateAuthority_OtherNameProperty
- type CfnCertificateAuthority_RevocationConfigurationProperty
- type CfnCertificateAuthority_SubjectProperty
- type CfnCertificateProps
- type CfnCertificate_ApiPassthroughProperty
- type CfnCertificate_CustomAttributeProperty
- type CfnCertificate_CustomExtensionProperty
- type CfnCertificate_EdiPartyNameProperty
- type CfnCertificate_ExtendedKeyUsageProperty
- type CfnCertificate_ExtensionsProperty
- type CfnCertificate_GeneralNameProperty
- type CfnCertificate_KeyUsageProperty
- type CfnCertificate_OtherNameProperty
- type CfnCertificate_PolicyInformationProperty
- type CfnCertificate_PolicyQualifierInfoProperty
- type CfnCertificate_QualifierProperty
- type CfnCertificate_SubjectProperty
- type CfnCertificate_ValidityProperty
- type CfnPermission
- type CfnPermissionProps
- type ICertificateAuthority
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCertificateAuthorityActivation_CFN_RESOURCE_TYPE_NAME ¶
func CfnCertificateAuthorityActivation_CFN_RESOURCE_TYPE_NAME() *string
func CfnCertificateAuthorityActivation_IsCfnElement ¶
func CfnCertificateAuthorityActivation_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCertificateAuthorityActivation_IsCfnResource ¶
func CfnCertificateAuthorityActivation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCertificateAuthorityActivation_IsConstruct ¶
func CfnCertificateAuthorityActivation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCertificateAuthority_CFN_RESOURCE_TYPE_NAME ¶
func CfnCertificateAuthority_CFN_RESOURCE_TYPE_NAME() *string
func CfnCertificateAuthority_IsCfnElement ¶
func CfnCertificateAuthority_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCertificateAuthority_IsCfnResource ¶
func CfnCertificateAuthority_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCertificateAuthority_IsConstruct ¶
func CfnCertificateAuthority_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCertificate_CFN_RESOURCE_TYPE_NAME ¶
func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnCertificate_IsCfnElement ¶
func CfnCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCertificate_IsCfnResource ¶
func CfnCertificate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCertificate_IsConstruct ¶
func CfnCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPermission_CFN_RESOURCE_TYPE_NAME ¶
func CfnPermission_CFN_RESOURCE_TYPE_NAME() *string
func CfnPermission_IsCfnElement ¶
func CfnPermission_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPermission_IsCfnResource ¶
func CfnPermission_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPermission_IsConstruct ¶
func CfnPermission_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCertificateAuthorityActivation_Override ¶
func NewCfnCertificateAuthorityActivation_Override(c CfnCertificateAuthorityActivation, scope constructs.Construct, id *string, props *CfnCertificateAuthorityActivationProps)
func NewCfnCertificateAuthority_Override ¶
func NewCfnCertificateAuthority_Override(c CfnCertificateAuthority, scope constructs.Construct, id *string, props *CfnCertificateAuthorityProps)
func NewCfnCertificate_Override ¶
func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)
func NewCfnPermission_Override ¶
func NewCfnPermission_Override(c CfnPermission, scope constructs.Construct, id *string, props *CfnPermissionProps)
Types ¶
type CertificateAuthority ¶
type CertificateAuthority interface { }
Defines a Certificate for ACMPCA.
Example:
import acmpca "github.com/aws/aws-cdk-go/awscdk" var vpc vpc cluster := msk.NewCluster(this, jsii.String("Cluster"), &ClusterProps{ ClusterName: jsii.String("myCluster"), KafkaVersion: msk.KafkaVersion_V2_8_1(), Vpc: Vpc, EncryptionInTransit: &EncryptionInTransitConfig{ ClientBroker: msk.ClientBrokerEncryption_TLS, }, ClientAuthentication: msk.ClientAuthentication_Tls(&TlsAuthProps{ CertificateAuthorities: []iCertificateAuthority{ acmpca.CertificateAuthority_FromCertificateAuthorityArn(this, jsii.String("CertificateAuthority"), jsii.String("arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/11111111-1111-1111-1111-111111111111")), }, }), })
type CfnCertificate ¶
type CfnCertificate interface { awscdk.CfnResource awscdk.IInspectable // Specifies X.509 certificate information to be included in the issued certificate. An `APIPassthrough` or `APICSRPassthrough` template variant must be selected, or else this parameter is ignored. ApiPassthrough() interface{} SetApiPassthrough(val interface{}) // The Amazon Resource Name (ARN) of the issued certificate. AttrArn() *string // The issued Base64 PEM-encoded certificate. AttrCertificate() *string // The Amazon Resource Name (ARN) for the private CA issues the certificate. CertificateAuthorityArn() *string SetCertificateAuthorityArn(val *string) // The certificate signing request (CSR) for the certificate. CertificateSigningRequest() *string SetCertificateSigningRequest(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The name of the algorithm that will be used to sign the certificate to be issued. SigningAlgorithm() *string SetSigningAlgorithm(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Specifies a custom configuration template to use when issuing a certificate. TemplateArn() *string SetTemplateArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The period of time during which the certificate will be valid. Validity() interface{} SetValidity(val interface{}) // Information describing the start of the validity period of the certificate. ValidityNotBefore() interface{} SetValidityNotBefore(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ACMPCA::Certificate` resource is used to issue a certificate using your private certificate authority.
For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificate := awscdk.Aws_acmpca.NewCfnCertificate(this, jsii.String("MyCfnCertificate"), &CfnCertificateProps{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CertificateSigningRequest: jsii.String("certificateSigningRequest"), SigningAlgorithm: jsii.String("signingAlgorithm"), Validity: &ValidityProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, // the properties below are optional ApiPassthrough: &ApiPassthroughProperty{ Extensions: &ExtensionsProperty{ CertificatePolicies: []interface{}{ &PolicyInformationProperty{ CertPolicyId: jsii.String("certPolicyId"), // the properties below are optional PolicyQualifiers: []interface{}{ &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }, }, }, }, CustomExtensions: []interface{}{ &CustomExtensionProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), // the properties below are optional Critical: jsii.Boolean(false), }, }, ExtendedKeyUsage: []interface{}{ &ExtendedKeyUsageProperty{ ExtendedKeyUsageObjectIdentifier: jsii.String("extendedKeyUsageObjectIdentifier"), ExtendedKeyUsageType: jsii.String("extendedKeyUsageType"), }, }, KeyUsage: &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }, SubjectAlternativeNames: []interface{}{ &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, }, }, Subject: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, }, TemplateArn: jsii.String("templateArn"), ValidityNotBefore: &ValidityProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html
func NewCfnCertificate ¶
func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate
type CfnCertificateAuthority ¶
type CfnCertificateAuthority interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) for the private CA that issued the certificate. AttrArn() *string // The Base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate. AttrCertificateSigningRequest() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies information to be added to the extension section of the certificate signing request (CSR). CsrExtensions() interface{} SetCsrExtensions(val interface{}) // Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. KeyAlgorithm() *string SetKeyAlgorithm(val *string) // Specifies a cryptographic key management compliance standard used for handling CA keys. KeyStorageSecurityStandard() *string SetKeyStorageSecurityStandard(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide* . RevocationConfiguration() interface{} SetRevocationConfiguration(val interface{}) // Name of the algorithm your private CA uses to sign certificate requests. SigningAlgorithm() *string SetSigningAlgorithm(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Structure that contains X.500 distinguished name information for your private CA. Subject() interface{} SetSubject(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Key-value pairs that will be attached to the new private CA. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Type of your private CA. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. UsageMode() *string SetUsageMode(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Use the `AWS::ACMPCA::CertificateAuthority` resource to create a private CA.
Once the CA exists, you can use the `AWS::ACMPCA::Certificate` resource to issue a new CA certificate. Alternatively, you can issue a CA certificate using an on-premises CA, and then use the `AWS::ACMPCA::CertificateAuthorityActivation` resource to import the new CA certificate and activate the CA.
> Before removing a `AWS::ACMPCA::CertificateAuthority` resource from the CloudFormation stack, disable the affected CA. Otherwise, the action will fail. You can disable the CA by removing its associated `AWS::ACMPCA::CertificateAuthorityActivation` resource from CloudFormation.
Example:
cfnCertificateAuthority := acmpca.NewCfnCertificateAuthority(this, jsii.String("CA"), &CfnCertificateAuthorityProps{ Type: jsii.String("ROOT"), KeyAlgorithm: jsii.String("RSA_2048"), SigningAlgorithm: jsii.String("SHA256WITHRSA"), Subject: &SubjectProperty{ Country: jsii.String("US"), Organization: jsii.String("string"), OrganizationalUnit: jsii.String("string"), DistinguishedNameQualifier: jsii.String("string"), State: jsii.String("string"), CommonName: jsii.String("123"), SerialNumber: jsii.String("string"), Locality: jsii.String("string"), Title: jsii.String("string"), Surname: jsii.String("string"), GivenName: jsii.String("string"), Initials: jsii.String("DG"), Pseudonym: jsii.String("string"), GenerationQualifier: jsii.String("DBG"), }, })
func NewCfnCertificateAuthority ¶
func NewCfnCertificateAuthority(scope constructs.Construct, id *string, props *CfnCertificateAuthorityProps) CfnCertificateAuthority
type CfnCertificateAuthorityActivation ¶
type CfnCertificateAuthorityActivation interface { awscdk.CfnResource awscdk.IInspectable // The complete Base64 PEM-encoded certificate chain, including the certificate authority certificate. AttrCompleteCertificateChain() *string // The Base64 PEM-encoded certificate authority certificate. Certificate() *string SetCertificate(val *string) // The Amazon Resource Name (ARN) of your private CA. CertificateAuthorityArn() *string SetCertificateAuthorityArn(val *string) // The Base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate. CertificateChain() *string SetCertificateChain(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Status of your private CA. Status() *string SetStatus(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ACMPCA::CertificateAuthorityActivation` resource creates and installs a CA certificate on a CA.
If no status is specified, the `AWS::ACMPCA::CertificateAuthorityActivation` resource status defaults to ACTIVE. Once the CA has a CA certificate installed, you can use the resource to toggle the CA status field between `ACTIVE` and `DISABLED` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificateAuthorityActivation := awscdk.Aws_acmpca.NewCfnCertificateAuthorityActivation(this, jsii.String("MyCfnCertificateAuthorityActivation"), &CfnCertificateAuthorityActivationProps{ Certificate: jsii.String("certificate"), CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), // the properties below are optional CertificateChain: jsii.String("certificateChain"), Status: jsii.String("status"), })
func NewCfnCertificateAuthorityActivation ¶
func NewCfnCertificateAuthorityActivation(scope constructs.Construct, id *string, props *CfnCertificateAuthorityActivationProps) CfnCertificateAuthorityActivation
type CfnCertificateAuthorityActivationProps ¶
type CfnCertificateAuthorityActivationProps struct { // The Base64 PEM-encoded certificate authority certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificate // Certificate *string `field:"required" json:"certificate" yaml:"certificate"` // The Amazon Resource Name (ARN) of your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificateauthorityarn // CertificateAuthorityArn *string `field:"required" json:"certificateAuthorityArn" yaml:"certificateAuthorityArn"` // The Base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificatechain // CertificateChain *string `field:"optional" json:"certificateChain" yaml:"certificateChain"` // Status of your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-status // Status *string `field:"optional" json:"status" yaml:"status"` }
Properties for defining a `CfnCertificateAuthorityActivation`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificateAuthorityActivationProps := &CfnCertificateAuthorityActivationProps{ Certificate: jsii.String("certificate"), CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), // the properties below are optional CertificateChain: jsii.String("certificateChain"), Status: jsii.String("status"), }
type CfnCertificateAuthorityProps ¶
type CfnCertificateAuthorityProps struct { // Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. // // When you create a subordinate CA, you must use a key algorithm supported by the parent CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keyalgorithm // KeyAlgorithm *string `field:"required" json:"keyAlgorithm" yaml:"keyAlgorithm"` // Name of the algorithm your private CA uses to sign certificate requests. // // This parameter should not be confused with the `SigningAlgorithm` parameter used to sign certificates when they are issued. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-signingalgorithm // SigningAlgorithm *string `field:"required" json:"signingAlgorithm" yaml:"signingAlgorithm"` // Structure that contains X.500 distinguished name information for your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-subject // Subject interface{} `field:"required" json:"subject" yaml:"subject"` // Type of your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-type // Type *string `field:"required" json:"type" yaml:"type"` // Specifies information to be added to the extension section of the certificate signing request (CSR). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-csrextensions // CsrExtensions interface{} `field:"optional" json:"csrExtensions" yaml:"csrExtensions"` // Specifies a cryptographic key management compliance standard used for handling CA keys. // // Default: FIPS_140_2_LEVEL_3_OR_HIGHER // // > Some AWS Regions do not support the default. When creating a CA in these Regions, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard` . Failure to do this results in an `InvalidArgsException` with the message, "A certificate authority cannot be created in this region with the specified security standard." // > // > For information about security standard support in various Regions, see [Storage and security compliance of AWS Private CA private keys](https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keystoragesecuritystandard // KeyStorageSecurityStandard *string `field:"optional" json:"keyStorageSecurityStandard" yaml:"keyStorageSecurityStandard"` // Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide* . // // > The following requirements apply to revocation configurations. // > // > - A configuration disabling CRLs or OCSP must contain only the `Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included. // > - In a CRL configuration, the `S3BucketName` parameter must conform to the [Amazon S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) . // > - A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in a CNAME. // > - In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-revocationconfiguration // RevocationConfiguration interface{} `field:"optional" json:"revocationConfiguration" yaml:"revocationConfiguration"` // Key-value pairs that will be attached to the new private CA. // // You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see [Controlling Access Using IAM Tags](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. // // Short-lived certificate validity is limited to seven days. // // The default value is GENERAL_PURPOSE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-usagemode // UsageMode *string `field:"optional" json:"usageMode" yaml:"usageMode"` }
Properties for defining a `CfnCertificateAuthority`.
Example:
cfnCertificateAuthority := acmpca.NewCfnCertificateAuthority(this, jsii.String("CA"), &CfnCertificateAuthorityProps{ Type: jsii.String("ROOT"), KeyAlgorithm: jsii.String("RSA_2048"), SigningAlgorithm: jsii.String("SHA256WITHRSA"), Subject: &SubjectProperty{ Country: jsii.String("US"), Organization: jsii.String("string"), OrganizationalUnit: jsii.String("string"), DistinguishedNameQualifier: jsii.String("string"), State: jsii.String("string"), CommonName: jsii.String("123"), SerialNumber: jsii.String("string"), Locality: jsii.String("string"), Title: jsii.String("string"), Surname: jsii.String("string"), GivenName: jsii.String("string"), Initials: jsii.String("DG"), Pseudonym: jsii.String("string"), GenerationQualifier: jsii.String("DBG"), }, })
type CfnCertificateAuthority_AccessDescriptionProperty ¶
type CfnCertificateAuthority_AccessDescriptionProperty struct { // The location of `AccessDescription` information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accesslocation // AccessLocation interface{} `field:"required" json:"accessLocation" yaml:"accessLocation"` // The type and format of `AccessDescription` information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accessmethod // AccessMethod interface{} `field:"required" json:"accessMethod" yaml:"accessMethod"` }
Provides access information used by the `authorityInfoAccess` and `subjectInfoAccess` extensions described in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" accessDescriptionProperty := &AccessDescriptionProperty{ AccessLocation: &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, AccessMethod: &AccessMethodProperty{ AccessMethodType: jsii.String("accessMethodType"), CustomObjectIdentifier: jsii.String("customObjectIdentifier"), }, }
type CfnCertificateAuthority_AccessMethodProperty ¶
type CfnCertificateAuthority_AccessMethodProperty struct { // Specifies the `AccessMethod` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-accessmethodtype // AccessMethodType *string `field:"optional" json:"accessMethodType" yaml:"accessMethodType"` // An object identifier (OID) specifying the `AccessMethod` . // // The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-customobjectidentifier // CustomObjectIdentifier *string `field:"optional" json:"customObjectIdentifier" yaml:"customObjectIdentifier"` }
Describes the type and format of extension access.
Only one of `CustomObjectIdentifier` or `AccessMethodType` may be provided. Providing both results in `InvalidArgsException` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" accessMethodProperty := &AccessMethodProperty{ AccessMethodType: jsii.String("accessMethodType"), CustomObjectIdentifier: jsii.String("customObjectIdentifier"), }
type CfnCertificateAuthority_CrlConfigurationProperty ¶
type CfnCertificateAuthority_CrlConfigurationProperty struct { // Name inserted into the certificate *CRL Distribution Points* extension that enables the use of an alias for the CRL distribution point. // // Use this value if you don't want the name of your S3 bucket to be public. // // > The content of a Canonical Name (CNAME) record must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-customcname // CustomCname *string `field:"optional" json:"customCname" yaml:"customCname"` // Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. // // You can use this value to enable certificate revocation for a new CA when you call the `CreateCertificateAuthority` operation or for an existing CA when you call the `UpdateCertificateAuthority` operation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // Validity period of the CRL in days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-expirationindays // ExpirationInDays *float64 `field:"optional" json:"expirationInDays" yaml:"expirationInDays"` // Name of the S3 bucket that contains the CRL. // // If you do not provide a value for the *CustomCname* argument, the name of your S3 bucket is placed into the *CRL Distribution Points* extension of the issued certificate. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) operation. You must specify a [bucket policy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket. // // > The `S3BucketName` parameter must conform to the [S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3bucketname // S3BucketName *string `field:"optional" json:"s3BucketName" yaml:"s3BucketName"` // Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. // // If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access. // // If no value is specified, the default is PUBLIC_READ. // // *Note:* This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL` , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value. // // For more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3objectacl // S3ObjectAcl *string `field:"optional" json:"s3ObjectAcl" yaml:"s3ObjectAcl"` }
Contains configuration information for a certificate revocation list (CRL).
Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the *Enabled* parameter to `true` . Your private CA writes CRLs to an S3 bucket that you specify in the *S3BucketName* parameter. You can hide the name of your bucket by specifying a value for the *CustomCname* parameter. Your private CA copies the CNAME or the S3 bucket name to the *CRL Distribution Points* extension of each certificate it issues. Your S3 bucket policy must give write permission to AWS Private CA.
AWS Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see [Encrypting Your CRLs](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption) .
Your private CA uses the value in the *ExpirationInDays* parameter to calculate the *nextUpdate* field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.
A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, AWS Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
- *Version* : The current version number defined in RFC 5280 is V2. The integer value is 0x1. - *Signature Algorithm* : The name of the algorithm used to sign the CRL. - *Issuer* : The X.500 distinguished name of your private CA that issued the CRL. - *Last Update* : The issue date and time of this CRL. - *Next Update* : The day and time by which the next CRL will be issued. - *Revoked Certificates* : List of revoked certificates. Each list item contains the following information.
- *Serial Number* : The serial number, in hexadecimal format, of the revoked certificate. - *Revocation Date* : Date and time the certificate was revoked. - *CRL Entry Extensions* : Optional extensions for the CRL entry.
- *X509v3 CRL Reason Code* : Reason the certificate was revoked. - *CRL Extensions* : Optional extensions for the CRL.
- *X509v3 Authority Key Identifier* : Identifies the public key associated with the private key used to sign the certificate. - *X509v3 CRL Number:* : Decimal sequence number for the CRL. - *Signature Algorithm* : Algorithm used by your private CA to sign the CRL. - *Signature Value* : Signature computed over the CRL.
Certificate revocation lists created by AWS Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
`openssl crl -inform DER -text -in *crl_path* -noout`
For more information, see [Planning a certificate revocation list (CRL)](https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html) in the *AWS Private Certificate Authority User Guide*
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" crlConfigurationProperty := &CrlConfigurationProperty{ CustomCname: jsii.String("customCname"), Enabled: jsii.Boolean(false), ExpirationInDays: jsii.Number(123), S3BucketName: jsii.String("s3BucketName"), S3ObjectAcl: jsii.String("s3ObjectAcl"), }
type CfnCertificateAuthority_CsrExtensionsProperty ¶
type CfnCertificateAuthority_CsrExtensionsProperty struct { // Indicates the purpose of the certificate and of the key contained in the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-keyusage // KeyUsage interface{} `field:"optional" json:"keyUsage" yaml:"keyUsage"` // For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. // // For more information, see [Subject Information Access](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-subjectinformationaccess // SubjectInformationAccess interface{} `field:"optional" json:"subjectInformationAccess" yaml:"subjectInformationAccess"` }
Describes the certificate extensions to be added to the certificate signing request (CSR).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csrExtensionsProperty := &CsrExtensionsProperty{ KeyUsage: &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }, SubjectInformationAccess: []interface{}{ &AccessDescriptionProperty{ AccessLocation: &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, AccessMethod: &AccessMethodProperty{ AccessMethodType: jsii.String("accessMethodType"), CustomObjectIdentifier: jsii.String("customObjectIdentifier"), }, }, }, }
type CfnCertificateAuthority_CustomAttributeProperty ¶ added in v2.18.0
type CfnCertificateAuthority_CustomAttributeProperty struct { // Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-objectidentifier // ObjectIdentifier *string `field:"required" json:"objectIdentifier" yaml:"objectIdentifier"` // Specifies the attribute value of relative distinguished name (RDN). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-value // Value *string `field:"required" json:"value" yaml:"value"` }
Defines the X.500 relative distinguished name (RDN).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customAttributeProperty := &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }
type CfnCertificateAuthority_EdiPartyNameProperty ¶
type CfnCertificateAuthority_EdiPartyNameProperty struct { // Specifies the name assigner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-nameassigner // NameAssigner *string `field:"required" json:"nameAssigner" yaml:"nameAssigner"` // Specifies the party name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-partyname // PartyName *string `field:"required" json:"partyName" yaml:"partyName"` }
Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ediPartyNameProperty := &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }
type CfnCertificateAuthority_GeneralNameProperty ¶
type CfnCertificateAuthority_GeneralNameProperty struct { // Contains information about the certificate subject. // // The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-directoryname // DirectoryName interface{} `field:"optional" json:"directoryName" yaml:"directoryName"` // Represents `GeneralName` as a DNS name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-dnsname // DnsName *string `field:"optional" json:"dnsName" yaml:"dnsName"` // Represents `GeneralName` as an `EdiPartyName` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-edipartyname // EdiPartyName interface{} `field:"optional" json:"ediPartyName" yaml:"ediPartyName"` // Represents `GeneralName` as an IPv4 or IPv6 address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-ipaddress // IpAddress *string `field:"optional" json:"ipAddress" yaml:"ipAddress"` // Represents `GeneralName` using an `OtherName` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-othername // OtherName interface{} `field:"optional" json:"otherName" yaml:"otherName"` // Represents `GeneralName` as an object identifier (OID). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-registeredid // RegisteredId *string `field:"optional" json:"registeredId" yaml:"registeredId"` // Represents `GeneralName` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-rfc822name // Rfc822Name *string `field:"optional" json:"rfc822Name" yaml:"rfc822Name"` // Represents `GeneralName` as a URI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-uniformresourceidentifier // UniformResourceIdentifier *string `field:"optional" json:"uniformResourceIdentifier" yaml:"uniformResourceIdentifier"` }
Describes an ASN.1 X.400 `GeneralName` as defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) . Only one of the following naming options should be provided. Providing more than one option results in an `InvalidArgsException` error.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" generalNameProperty := &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }
type CfnCertificateAuthority_KeyUsageProperty ¶
type CfnCertificateAuthority_KeyUsageProperty struct { // Key can be used to sign CRLs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-crlsign // // Default: - false. // CrlSign interface{} `field:"optional" json:"crlSign" yaml:"crlSign"` // Key can be used to decipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-dataencipherment // // Default: - false. // DataEncipherment interface{} `field:"optional" json:"dataEncipherment" yaml:"dataEncipherment"` // Key can be used only to decipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-decipheronly // // Default: - false. // DecipherOnly interface{} `field:"optional" json:"decipherOnly" yaml:"decipherOnly"` // Key can be used for digital signing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-digitalsignature // // Default: - false. // DigitalSignature interface{} `field:"optional" json:"digitalSignature" yaml:"digitalSignature"` // Key can be used only to encipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-encipheronly // // Default: - false. // EncipherOnly interface{} `field:"optional" json:"encipherOnly" yaml:"encipherOnly"` // Key can be used in a key-agreement protocol. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyagreement // // Default: - false. // KeyAgreement interface{} `field:"optional" json:"keyAgreement" yaml:"keyAgreement"` // Key can be used to sign certificates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keycertsign // // Default: - false. // KeyCertSign interface{} `field:"optional" json:"keyCertSign" yaml:"keyCertSign"` // Key can be used to encipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyencipherment // // Default: - false. // KeyEncipherment interface{} `field:"optional" json:"keyEncipherment" yaml:"keyEncipherment"` // Key can be used for non-repudiation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-nonrepudiation // // Default: - false. // NonRepudiation interface{} `field:"optional" json:"nonRepudiation" yaml:"nonRepudiation"` }
Defines one or more purposes for which the key contained in the certificate can be used.
Default value for each option is false.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" keyUsageProperty := &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }
type CfnCertificateAuthority_OcspConfigurationProperty ¶
type CfnCertificateAuthority_OcspConfigurationProperty struct { // Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP). // // A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. // // > The content of a Canonical Name (CNAME) record must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-ocspcustomcname // OcspCustomCname *string `field:"optional" json:"ocspCustomCname" yaml:"ocspCustomCname"` }
Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ocspConfigurationProperty := &OcspConfigurationProperty{ Enabled: jsii.Boolean(false), OcspCustomCname: jsii.String("ocspCustomCname"), }
type CfnCertificateAuthority_OtherNameProperty ¶
type CfnCertificateAuthority_OtherNameProperty struct { // Specifies an OID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-typeid // TypeId *string `field:"required" json:"typeId" yaml:"typeId"` // Specifies an OID value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-value // Value *string `field:"required" json:"value" yaml:"value"` }
Defines a custom ASN.1 X.400 `GeneralName` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" otherNameProperty := &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }
type CfnCertificateAuthority_RevocationConfigurationProperty ¶
type CfnCertificateAuthority_RevocationConfigurationProperty struct { // Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-crlconfiguration // CrlConfiguration interface{} `field:"optional" json:"crlConfiguration" yaml:"crlConfiguration"` // Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-ocspconfiguration // OcspConfiguration interface{} `field:"optional" json:"ocspConfiguration" yaml:"ocspConfiguration"` }
Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide* .
> The following requirements apply to revocation configurations. > > - A configuration disabling CRLs or OCSP must contain only the `Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included. > - In a CRL configuration, the `S3BucketName` parameter must conform to the [Amazon S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) . > - A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in a CNAME. > - In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" revocationConfigurationProperty := &RevocationConfigurationProperty{ CrlConfiguration: &CrlConfigurationProperty{ CustomCname: jsii.String("customCname"), Enabled: jsii.Boolean(false), ExpirationInDays: jsii.Number(123), S3BucketName: jsii.String("s3BucketName"), S3ObjectAcl: jsii.String("s3ObjectAcl"), }, OcspConfiguration: &OcspConfigurationProperty{ Enabled: jsii.Boolean(false), OcspCustomCname: jsii.String("ocspCustomCname"), }, }
type CfnCertificateAuthority_SubjectProperty ¶
type CfnCertificateAuthority_SubjectProperty struct { // Fully qualified domain name (FQDN) associated with the certificate subject. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-commonname // CommonName *string `field:"optional" json:"commonName" yaml:"commonName"` // Two-digit code that specifies the country in which the certificate subject located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-country // Country *string `field:"optional" json:"country" yaml:"country"` // Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) . // // > Custom attributes cannot be used in combination with standard attributes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-customattributes // CustomAttributes interface{} `field:"optional" json:"customAttributes" yaml:"customAttributes"` // Disambiguating information for the certificate subject. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-distinguishednamequalifier // DistinguishedNameQualifier *string `field:"optional" json:"distinguishedNameQualifier" yaml:"distinguishedNameQualifier"` // Typically a qualifier appended to the name of an individual. // // Examples include Jr. for junior, Sr. for senior, and III for third. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-generationqualifier // GenerationQualifier *string `field:"optional" json:"generationQualifier" yaml:"generationQualifier"` // First name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-givenname // GivenName *string `field:"optional" json:"givenName" yaml:"givenName"` // Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-initials // Initials *string `field:"optional" json:"initials" yaml:"initials"` // The locality (such as a city or town) in which the certificate subject is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-locality // Locality *string `field:"optional" json:"locality" yaml:"locality"` // Legal name of the organization with which the certificate subject is affiliated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organization // Organization *string `field:"optional" json:"organization" yaml:"organization"` // A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organizationalunit // OrganizationalUnit *string `field:"optional" json:"organizationalUnit" yaml:"organizationalUnit"` // Typically a shortened version of a longer GivenName. // // For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-pseudonym // Pseudonym *string `field:"optional" json:"pseudonym" yaml:"pseudonym"` // The certificate serial number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-serialnumber // SerialNumber *string `field:"optional" json:"serialNumber" yaml:"serialNumber"` // State in which the subject of the certificate is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-state // State *string `field:"optional" json:"state" yaml:"state"` // Family name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-surname // Surname *string `field:"optional" json:"surname" yaml:"surname"` // A personal title such as Mr. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-title // Title *string `field:"optional" json:"title" yaml:"title"` }
ASN1 subject for the certificate authority.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" subjectProperty := &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }
type CfnCertificateProps ¶
type CfnCertificateProps struct { // The Amazon Resource Name (ARN) for the private CA issues the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificateauthorityarn // CertificateAuthorityArn *string `field:"required" json:"certificateAuthorityArn" yaml:"certificateAuthorityArn"` // The certificate signing request (CSR) for the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificatesigningrequest // CertificateSigningRequest *string `field:"required" json:"certificateSigningRequest" yaml:"certificateSigningRequest"` // The name of the algorithm that will be used to sign the certificate to be issued. // // This parameter should not be confused with the `SigningAlgorithm` parameter used to sign a CSR in the `CreateCertificateAuthority` action. // // > The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-signingalgorithm // SigningAlgorithm *string `field:"required" json:"signingAlgorithm" yaml:"signingAlgorithm"` // The period of time during which the certificate will be valid. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity // Validity interface{} `field:"required" json:"validity" yaml:"validity"` // Specifies X.509 certificate information to be included in the issued certificate. An `APIPassthrough` or `APICSRPassthrough` template variant must be selected, or else this parameter is ignored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-apipassthrough // ApiPassthrough interface{} `field:"optional" json:"apiPassthrough" yaml:"apiPassthrough"` // Specifies a custom configuration template to use when issuing a certificate. // // If this parameter is not provided, AWS Private CA defaults to the `EndEntityCertificate/V1` template. For more information about AWS Private CA templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-templatearn // TemplateArn *string `field:"optional" json:"templateArn" yaml:"templateArn"` // Information describing the start of the validity period of the certificate. // // This parameter sets the “Not Before" date for the certificate. // // By default, when issuing a certificate, AWS Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The `ValidityNotBefore` parameter can be used to customize the “Not Before” value. // // Unlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional. // // The `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validitynotbefore // ValidityNotBefore interface{} `field:"optional" json:"validityNotBefore" yaml:"validityNotBefore"` }
Properties for defining a `CfnCertificate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificateProps := &CfnCertificateProps{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CertificateSigningRequest: jsii.String("certificateSigningRequest"), SigningAlgorithm: jsii.String("signingAlgorithm"), Validity: &ValidityProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, // the properties below are optional ApiPassthrough: &ApiPassthroughProperty{ Extensions: &ExtensionsProperty{ CertificatePolicies: []interface{}{ &PolicyInformationProperty{ CertPolicyId: jsii.String("certPolicyId"), // the properties below are optional PolicyQualifiers: []interface{}{ &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }, }, }, }, CustomExtensions: []interface{}{ &CustomExtensionProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), // the properties below are optional Critical: jsii.Boolean(false), }, }, ExtendedKeyUsage: []interface{}{ &ExtendedKeyUsageProperty{ ExtendedKeyUsageObjectIdentifier: jsii.String("extendedKeyUsageObjectIdentifier"), ExtendedKeyUsageType: jsii.String("extendedKeyUsageType"), }, }, KeyUsage: &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }, SubjectAlternativeNames: []interface{}{ &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, }, }, Subject: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, }, TemplateArn: jsii.String("templateArn"), ValidityNotBefore: &ValidityProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html
type CfnCertificate_ApiPassthroughProperty ¶
type CfnCertificate_ApiPassthroughProperty struct { // Specifies X.509 extension information for a certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-extensions // Extensions interface{} `field:"optional" json:"extensions" yaml:"extensions"` // Contains information about the certificate subject. // // The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-subject // Subject interface{} `field:"optional" json:"subject" yaml:"subject"` }
Contains X.509 certificate information to be placed in an issued certificate. An `APIPassthrough` or `APICSRPassthrough` template variant must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" apiPassthroughProperty := &ApiPassthroughProperty{ Extensions: &ExtensionsProperty{ CertificatePolicies: []interface{}{ &PolicyInformationProperty{ CertPolicyId: jsii.String("certPolicyId"), // the properties below are optional PolicyQualifiers: []interface{}{ &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }, }, }, }, CustomExtensions: []interface{}{ &CustomExtensionProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), // the properties below are optional Critical: jsii.Boolean(false), }, }, ExtendedKeyUsage: []interface{}{ &ExtendedKeyUsageProperty{ ExtendedKeyUsageObjectIdentifier: jsii.String("extendedKeyUsageObjectIdentifier"), ExtendedKeyUsageType: jsii.String("extendedKeyUsageType"), }, }, KeyUsage: &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }, SubjectAlternativeNames: []interface{}{ &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, }, }, Subject: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, }
type CfnCertificate_CustomAttributeProperty ¶ added in v2.18.0
type CfnCertificate_CustomAttributeProperty struct { // Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html#cfn-acmpca-certificate-customattribute-objectidentifier // ObjectIdentifier *string `field:"required" json:"objectIdentifier" yaml:"objectIdentifier"` // Specifies the attribute value of relative distinguished name (RDN). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html#cfn-acmpca-certificate-customattribute-value // Value *string `field:"required" json:"value" yaml:"value"` }
Defines the X.500 relative distinguished name (RDN).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customAttributeProperty := &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }
type CfnCertificate_CustomExtensionProperty ¶ added in v2.18.0
type CfnCertificate_CustomExtensionProperty struct { // Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-objectidentifier // ObjectIdentifier *string `field:"required" json:"objectIdentifier" yaml:"objectIdentifier"` // Specifies the base64-encoded value of the X.509 extension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-value // Value *string `field:"required" json:"value" yaml:"value"` // Specifies the critical flag of the X.509 extension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-critical // Critical interface{} `field:"optional" json:"critical" yaml:"critical"` }
Specifies the X.509 extension information for a certificate.
Extensions present in `CustomExtensions` follow the `ApiPassthrough` [template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customExtensionProperty := &CustomExtensionProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), // the properties below are optional Critical: jsii.Boolean(false), }
type CfnCertificate_EdiPartyNameProperty ¶
type CfnCertificate_EdiPartyNameProperty struct { // Specifies the name assigner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html#cfn-acmpca-certificate-edipartyname-nameassigner // NameAssigner *string `field:"required" json:"nameAssigner" yaml:"nameAssigner"` // Specifies the party name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html#cfn-acmpca-certificate-edipartyname-partyname // PartyName *string `field:"required" json:"partyName" yaml:"partyName"` }
Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ediPartyNameProperty := &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }
type CfnCertificate_ExtendedKeyUsageProperty ¶
type CfnCertificate_ExtendedKeyUsageProperty struct { // Specifies a custom `ExtendedKeyUsage` with an object identifier (OID). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier // ExtendedKeyUsageObjectIdentifier *string `field:"optional" json:"extendedKeyUsageObjectIdentifier" yaml:"extendedKeyUsageObjectIdentifier"` // Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype // ExtendedKeyUsageType *string `field:"optional" json:"extendedKeyUsageType" yaml:"extendedKeyUsageType"` }
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" extendedKeyUsageProperty := &ExtendedKeyUsageProperty{ ExtendedKeyUsageObjectIdentifier: jsii.String("extendedKeyUsageObjectIdentifier"), ExtendedKeyUsageType: jsii.String("extendedKeyUsageType"), }
type CfnCertificate_ExtensionsProperty ¶
type CfnCertificate_ExtensionsProperty struct { // Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. // // For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) . // // In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-certificatepolicies // CertificatePolicies interface{} `field:"optional" json:"certificatePolicies" yaml:"certificatePolicies"` // Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-customextensions // CustomExtensions interface{} `field:"optional" json:"customExtensions" yaml:"customExtensions"` // Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-extendedkeyusage // ExtendedKeyUsage interface{} `field:"optional" json:"extendedKeyUsage" yaml:"extendedKeyUsage"` // Defines one or more purposes for which the key contained in the certificate can be used. // // Default value for each option is false. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-keyusage // KeyUsage interface{} `field:"optional" json:"keyUsage" yaml:"keyUsage"` // The subject alternative name extension allows identities to be bound to the subject of the certificate. // // These identities may be included in addition to or in place of the identity in the subject field of the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-subjectalternativenames // SubjectAlternativeNames interface{} `field:"optional" json:"subjectAlternativeNames" yaml:"subjectAlternativeNames"` }
Contains X.509 extension information for a certificate.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" extensionsProperty := &ExtensionsProperty{ CertificatePolicies: []interface{}{ &PolicyInformationProperty{ CertPolicyId: jsii.String("certPolicyId"), // the properties below are optional PolicyQualifiers: []interface{}{ &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }, }, }, }, CustomExtensions: []interface{}{ &CustomExtensionProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), // the properties below are optional Critical: jsii.Boolean(false), }, }, ExtendedKeyUsage: []interface{}{ &ExtendedKeyUsageProperty{ ExtendedKeyUsageObjectIdentifier: jsii.String("extendedKeyUsageObjectIdentifier"), ExtendedKeyUsageType: jsii.String("extendedKeyUsageType"), }, }, KeyUsage: &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }, SubjectAlternativeNames: []interface{}{ &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }, }, }
type CfnCertificate_GeneralNameProperty ¶
type CfnCertificate_GeneralNameProperty struct { // Contains information about the certificate subject. // // The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-directoryname // DirectoryName interface{} `field:"optional" json:"directoryName" yaml:"directoryName"` // Represents `GeneralName` as a DNS name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-dnsname // DnsName *string `field:"optional" json:"dnsName" yaml:"dnsName"` // Represents `GeneralName` as an `EdiPartyName` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-edipartyname // EdiPartyName interface{} `field:"optional" json:"ediPartyName" yaml:"ediPartyName"` // Represents `GeneralName` as an IPv4 or IPv6 address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-ipaddress // IpAddress *string `field:"optional" json:"ipAddress" yaml:"ipAddress"` // Represents `GeneralName` using an `OtherName` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-othername // OtherName interface{} `field:"optional" json:"otherName" yaml:"otherName"` // Represents `GeneralName` as an object identifier (OID). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-registeredid // RegisteredId *string `field:"optional" json:"registeredId" yaml:"registeredId"` // Represents `GeneralName` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-rfc822name // Rfc822Name *string `field:"optional" json:"rfc822Name" yaml:"rfc822Name"` // Represents `GeneralName` as a URI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-uniformresourceidentifier // UniformResourceIdentifier *string `field:"optional" json:"uniformResourceIdentifier" yaml:"uniformResourceIdentifier"` }
Describes an ASN.1 X.400 `GeneralName` as defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) . Only one of the following naming options should be provided. Providing more than one option results in an `InvalidArgsException` error.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" generalNameProperty := &GeneralNameProperty{ DirectoryName: &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }, DnsName: jsii.String("dnsName"), EdiPartyName: &EdiPartyNameProperty{ NameAssigner: jsii.String("nameAssigner"), PartyName: jsii.String("partyName"), }, IpAddress: jsii.String("ipAddress"), OtherName: &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }, RegisteredId: jsii.String("registeredId"), Rfc822Name: jsii.String("rfc822Name"), UniformResourceIdentifier: jsii.String("uniformResourceIdentifier"), }
type CfnCertificate_KeyUsageProperty ¶
type CfnCertificate_KeyUsageProperty struct { // Key can be used to sign CRLs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-crlsign // // Default: - false. // CrlSign interface{} `field:"optional" json:"crlSign" yaml:"crlSign"` // Key can be used to decipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-dataencipherment // // Default: - false. // DataEncipherment interface{} `field:"optional" json:"dataEncipherment" yaml:"dataEncipherment"` // Key can be used only to decipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-decipheronly // // Default: - false. // DecipherOnly interface{} `field:"optional" json:"decipherOnly" yaml:"decipherOnly"` // Key can be used for digital signing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-digitalsignature // // Default: - false. // DigitalSignature interface{} `field:"optional" json:"digitalSignature" yaml:"digitalSignature"` // Key can be used only to encipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-encipheronly // // Default: - false. // EncipherOnly interface{} `field:"optional" json:"encipherOnly" yaml:"encipherOnly"` // Key can be used in a key-agreement protocol. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keyagreement // // Default: - false. // KeyAgreement interface{} `field:"optional" json:"keyAgreement" yaml:"keyAgreement"` // Key can be used to sign certificates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keycertsign // // Default: - false. // KeyCertSign interface{} `field:"optional" json:"keyCertSign" yaml:"keyCertSign"` // Key can be used to encipher data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keyencipherment // // Default: - false. // KeyEncipherment interface{} `field:"optional" json:"keyEncipherment" yaml:"keyEncipherment"` // Key can be used for non-repudiation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-nonrepudiation // // Default: - false. // NonRepudiation interface{} `field:"optional" json:"nonRepudiation" yaml:"nonRepudiation"` }
Defines one or more purposes for which the key contained in the certificate can be used.
Default value for each option is false.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" keyUsageProperty := &KeyUsageProperty{ CrlSign: jsii.Boolean(false), DataEncipherment: jsii.Boolean(false), DecipherOnly: jsii.Boolean(false), DigitalSignature: jsii.Boolean(false), EncipherOnly: jsii.Boolean(false), KeyAgreement: jsii.Boolean(false), KeyCertSign: jsii.Boolean(false), KeyEncipherment: jsii.Boolean(false), NonRepudiation: jsii.Boolean(false), }
type CfnCertificate_OtherNameProperty ¶
type CfnCertificate_OtherNameProperty struct { // Specifies an OID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html#cfn-acmpca-certificate-othername-typeid // TypeId *string `field:"required" json:"typeId" yaml:"typeId"` // Specifies an OID value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html#cfn-acmpca-certificate-othername-value // Value *string `field:"required" json:"value" yaml:"value"` }
Defines a custom ASN.1 X.400 `GeneralName` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" otherNameProperty := &OtherNameProperty{ TypeId: jsii.String("typeId"), Value: jsii.String("value"), }
type CfnCertificate_PolicyInformationProperty ¶
type CfnCertificate_PolicyInformationProperty struct { // Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. // // For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-certpolicyid // CertPolicyId *string `field:"required" json:"certPolicyId" yaml:"certPolicyId"` // Modifies the given `CertPolicyId` with a qualifier. // // AWS Private CA supports the certification practice statement (CPS) qualifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-policyqualifiers // PolicyQualifiers interface{} `field:"optional" json:"policyQualifiers" yaml:"policyQualifiers"` }
Defines the X.509 `CertificatePolicies` extension.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" policyInformationProperty := &PolicyInformationProperty{ CertPolicyId: jsii.String("certPolicyId"), // the properties below are optional PolicyQualifiers: []interface{}{ &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }, }, }
type CfnCertificate_PolicyQualifierInfoProperty ¶
type CfnCertificate_PolicyQualifierInfoProperty struct { // Identifies the qualifier modifying a `CertPolicyId` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid // PolicyQualifierId *string `field:"required" json:"policyQualifierId" yaml:"policyQualifierId"` // Defines the qualifier type. // // AWS Private CA supports the use of a URI for a CPS qualifier in this field. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-qualifier // Qualifier interface{} `field:"required" json:"qualifier" yaml:"qualifier"` }
Modifies the `CertPolicyId` of a `PolicyInformation` object with a qualifier.
AWS Private CA supports the certification practice statement (CPS) qualifier.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" policyQualifierInfoProperty := &PolicyQualifierInfoProperty{ PolicyQualifierId: jsii.String("policyQualifierId"), Qualifier: &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }, }
type CfnCertificate_QualifierProperty ¶
type CfnCertificate_QualifierProperty struct { // Contains a pointer to a certification practice statement (CPS) published by the CA. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html#cfn-acmpca-certificate-qualifier-cpsuri // CpsUri *string `field:"required" json:"cpsUri" yaml:"cpsUri"` }
Defines a `PolicyInformation` qualifier.
AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" qualifierProperty := &QualifierProperty{ CpsUri: jsii.String("cpsUri"), }
type CfnCertificate_SubjectProperty ¶
type CfnCertificate_SubjectProperty struct { // For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. // // Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-commonname // CommonName *string `field:"optional" json:"commonName" yaml:"commonName"` // Two-digit code that specifies the country in which the certificate subject located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-country // Country *string `field:"optional" json:"country" yaml:"country"` // Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier) . // // > Custom attributes cannot be used in combination with standard attributes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-customattributes // CustomAttributes interface{} `field:"optional" json:"customAttributes" yaml:"customAttributes"` // Disambiguating information for the certificate subject. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-distinguishednamequalifier // DistinguishedNameQualifier *string `field:"optional" json:"distinguishedNameQualifier" yaml:"distinguishedNameQualifier"` // Typically a qualifier appended to the name of an individual. // // Examples include Jr. for junior, Sr. for senior, and III for third. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-generationqualifier // GenerationQualifier *string `field:"optional" json:"generationQualifier" yaml:"generationQualifier"` // First name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-givenname // GivenName *string `field:"optional" json:"givenName" yaml:"givenName"` // Concatenation that typically contains the first letter of the *GivenName* , the first letter of the middle name if one exists, and the first letter of the *Surname* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-initials // Initials *string `field:"optional" json:"initials" yaml:"initials"` // The locality (such as a city or town) in which the certificate subject is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-locality // Locality *string `field:"optional" json:"locality" yaml:"locality"` // Legal name of the organization with which the certificate subject is affiliated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-organization // Organization *string `field:"optional" json:"organization" yaml:"organization"` // A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-organizationalunit // OrganizationalUnit *string `field:"optional" json:"organizationalUnit" yaml:"organizationalUnit"` // Typically a shortened version of a longer *GivenName* . // // For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-pseudonym // Pseudonym *string `field:"optional" json:"pseudonym" yaml:"pseudonym"` // The certificate serial number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-serialnumber // SerialNumber *string `field:"optional" json:"serialNumber" yaml:"serialNumber"` // State in which the subject of the certificate is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-state // State *string `field:"optional" json:"state" yaml:"state"` // Family name. // // In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-surname // Surname *string `field:"optional" json:"surname" yaml:"surname"` // A title such as Mr. // // or Ms., which is pre-pended to the name to refer formally to the certificate subject. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-title // Title *string `field:"optional" json:"title" yaml:"title"` }
Contains information about the certificate subject.
The `Subject` field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The `Subject` must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" subjectProperty := &SubjectProperty{ CommonName: jsii.String("commonName"), Country: jsii.String("country"), CustomAttributes: []interface{}{ &CustomAttributeProperty{ ObjectIdentifier: jsii.String("objectIdentifier"), Value: jsii.String("value"), }, }, DistinguishedNameQualifier: jsii.String("distinguishedNameQualifier"), GenerationQualifier: jsii.String("generationQualifier"), GivenName: jsii.String("givenName"), Initials: jsii.String("initials"), Locality: jsii.String("locality"), Organization: jsii.String("organization"), OrganizationalUnit: jsii.String("organizationalUnit"), Pseudonym: jsii.String("pseudonym"), SerialNumber: jsii.String("serialNumber"), State: jsii.String("state"), Surname: jsii.String("surname"), Title: jsii.String("title"), }
type CfnCertificate_ValidityProperty ¶
type CfnCertificate_ValidityProperty struct { // Specifies whether the `Value` parameter represents days, months, or years. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-type // Type *string `field:"required" json:"type" yaml:"type"` // A long integer interpreted according to the value of `Type` , below. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-value // Value *float64 `field:"required" json:"value" yaml:"value"` }
Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years.
You can issue a certificate by calling the `IssueCertificate` operation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" validityProperty := &ValidityProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }
type CfnPermission ¶
type CfnPermission interface { awscdk.CfnResource awscdk.IInspectable // The private CA actions that can be performed by the designated AWS service. Actions() *[]*string SetActions(val *[]*string) // The Amazon Resource Number (ARN) of the private CA from which the permission was issued. CertificateAuthorityArn() *string SetCertificateAuthorityArn(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The AWS service or entity that holds the permission. Principal() *string SetPrincipal(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The ID of the account that assigned the permission. SourceAccount() *string SetSourceAccount(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Grants permissions to the AWS Certificate Manager ( ACM ) service principal ( `acm.amazonaws.com` ) to perform [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) , [GetCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) , and [ListPermissions](https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) actions on a CA. These actions are needed for the ACM principal to renew private PKI certificates requested through ACM and residing in the same AWS account as the CA.
**About permissions** - If the private CA and the certificates it issues reside in the same account, you can use `AWS::ACMPCA::Permission` to grant permissions for ACM to carry out automatic certificate renewals. - For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list permissions. - If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see [Using a Resource Based Policy with AWS Private CA](https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) .
> To update an `AWS::ACMPCA::Permission` resource, you must first delete the existing permission resource from the CloudFormation stack and then create a new permission resource with updated properties.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPermission := awscdk.Aws_acmpca.NewCfnPermission(this, jsii.String("MyCfnPermission"), &CfnPermissionProps{ Actions: []*string{ jsii.String("actions"), }, CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), Principal: jsii.String("principal"), // the properties below are optional SourceAccount: jsii.String("sourceAccount"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html
func NewCfnPermission ¶
func NewCfnPermission(scope constructs.Construct, id *string, props *CfnPermissionProps) CfnPermission
type CfnPermissionProps ¶
type CfnPermissionProps struct { // The private CA actions that can be performed by the designated AWS service. // // Supported actions are `IssueCertificate` , `GetCertificate` , and `ListPermissions` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions // Actions *[]*string `field:"required" json:"actions" yaml:"actions"` // The Amazon Resource Number (ARN) of the private CA from which the permission was issued. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-certificateauthorityarn // CertificateAuthorityArn *string `field:"required" json:"certificateAuthorityArn" yaml:"certificateAuthorityArn"` // The AWS service or entity that holds the permission. // // At this time, the only valid principal is `acm.amazonaws.com` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-principal // Principal *string `field:"required" json:"principal" yaml:"principal"` // The ID of the account that assigned the permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-sourceaccount // SourceAccount *string `field:"optional" json:"sourceAccount" yaml:"sourceAccount"` }
Properties for defining a `CfnPermission`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPermissionProps := &CfnPermissionProps{ Actions: []*string{ jsii.String("actions"), }, CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), Principal: jsii.String("principal"), // the properties below are optional SourceAccount: jsii.String("sourceAccount"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html
type ICertificateAuthority ¶
type ICertificateAuthority interface { awscdk.IResource // The Amazon Resource Name of the Certificate. CertificateAuthorityArn() *string }
Interface which all CertificateAuthority based class must implement.
func CertificateAuthority_FromCertificateAuthorityArn ¶
func CertificateAuthority_FromCertificateAuthorityArn(scope constructs.Construct, id *string, certificateAuthorityArn *string) ICertificateAuthority
Import an existing Certificate given an ARN.
Source Files ¶
- CertificateAuthority.go
- CertificateAuthority__checks.go
- CfnCertificate.go
- CfnCertificateAuthority.go
- CfnCertificateAuthorityActivation.go
- CfnCertificateAuthorityActivationProps.go
- CfnCertificateAuthorityActivation__checks.go
- CfnCertificateAuthorityProps.go
- CfnCertificateAuthority_AccessDescriptionProperty.go
- CfnCertificateAuthority_AccessMethodProperty.go
- CfnCertificateAuthority_CrlConfigurationProperty.go
- CfnCertificateAuthority_CsrExtensionsProperty.go
- CfnCertificateAuthority_CustomAttributeProperty.go
- CfnCertificateAuthority_EdiPartyNameProperty.go
- CfnCertificateAuthority_GeneralNameProperty.go
- CfnCertificateAuthority_KeyUsageProperty.go
- CfnCertificateAuthority_OcspConfigurationProperty.go
- CfnCertificateAuthority_OtherNameProperty.go
- CfnCertificateAuthority_RevocationConfigurationProperty.go
- CfnCertificateAuthority_SubjectProperty.go
- CfnCertificateAuthority__checks.go
- CfnCertificateProps.go
- CfnCertificate_ApiPassthroughProperty.go
- CfnCertificate_CustomAttributeProperty.go
- CfnCertificate_CustomExtensionProperty.go
- CfnCertificate_EdiPartyNameProperty.go
- CfnCertificate_ExtendedKeyUsageProperty.go
- CfnCertificate_ExtensionsProperty.go
- CfnCertificate_GeneralNameProperty.go
- CfnCertificate_KeyUsageProperty.go
- CfnCertificate_OtherNameProperty.go
- CfnCertificate_PolicyInformationProperty.go
- CfnCertificate_PolicyQualifierInfoProperty.go
- CfnCertificate_QualifierProperty.go
- CfnCertificate_SubjectProperty.go
- CfnCertificate_ValidityProperty.go
- CfnCertificate__checks.go
- CfnPermission.go
- CfnPermissionProps.go
- CfnPermission__checks.go
- ICertificateAuthority.go
- main.go