io.cloudshiftdev.awscdk.services.acmpca.CfnPermission.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.acmpca
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* 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 io.cloudshiftdev.awscdk.services.acmpca.*;
* CfnPermission cfnPermission = CfnPermission.Builder.create(this, "MyCfnPermission")
* .actions(List.of("actions"))
* .certificateAuthorityArn("certificateAuthorityArn")
* .principal("principal")
* // the properties below are optional
* .sourceAccount("sourceAccount")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html)
*/
public open class CfnPermission(
cdkObject: software.amazon.awscdk.services.acmpca.CfnPermission,
) : CfnResource(cdkObject),
IInspectable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnPermissionProps,
) :
this(software.amazon.awscdk.services.acmpca.CfnPermission(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnPermissionProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnPermissionProps.Builder.() -> Unit,
) : this(scope, id, CfnPermissionProps(props)
)
/**
* The private CA actions that can be performed by the designated AWS service.
*/
public open fun actions(): List = unwrap(this).getActions()
/**
* The private CA actions that can be performed by the designated AWS service.
*/
public open fun actions(`value`: List) {
unwrap(this).setActions(`value`)
}
/**
* The private CA actions that can be performed by the designated AWS service.
*/
public open fun actions(vararg `value`: String): Unit = actions(`value`.toList())
/**
* The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
*/
public open fun certificateAuthorityArn(): String = unwrap(this).getCertificateAuthorityArn()
/**
* The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
*/
public open fun certificateAuthorityArn(`value`: String) {
unwrap(this).setCertificateAuthorityArn(`value`)
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* The AWS service or entity that holds the permission.
*/
public open fun principal(): String = unwrap(this).getPrincipal()
/**
* The AWS service or entity that holds the permission.
*/
public open fun principal(`value`: String) {
unwrap(this).setPrincipal(`value`)
}
/**
* The ID of the account that assigned the permission.
*/
public open fun sourceAccount(): String? = unwrap(this).getSourceAccount()
/**
* The ID of the account that assigned the permission.
*/
public open fun sourceAccount(`value`: String) {
unwrap(this).setSourceAccount(`value`)
}
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.acmpca.CfnPermission].
*/
@CdkDslMarker
public interface Builder {
/**
* The private CA actions that can be performed by the designated AWS service.
*
* Supported actions are `IssueCertificate` , `GetCertificate` , and `ListPermissions` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions)
* @param actions The private CA actions that can be performed by the designated AWS service.
*/
public fun actions(actions: List)
/**
* The private CA actions that can be performed by the designated AWS service.
*
* Supported actions are `IssueCertificate` , `GetCertificate` , and `ListPermissions` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions)
* @param actions The private CA actions that can be performed by the designated AWS service.
*/
public fun actions(vararg actions: String)
/**
* The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-certificateauthorityarn)
* @param certificateAuthorityArn The Amazon Resource Number (ARN) of the private CA from which
* the permission was issued.
*/
public fun certificateAuthorityArn(certificateAuthorityArn: String)
/**
* The AWS service or entity that holds the permission.
*
* At this time, the only valid principal is `acm.amazonaws.com` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-principal)
* @param principal The AWS service or entity that holds the permission.
*/
public fun principal(principal: String)
/**
* The ID of the account that assigned the permission.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-sourceaccount)
* @param sourceAccount The ID of the account that assigned the permission.
*/
public fun sourceAccount(sourceAccount: String)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.acmpca.CfnPermission.Builder =
software.amazon.awscdk.services.acmpca.CfnPermission.Builder.create(scope, id)
/**
* The private CA actions that can be performed by the designated AWS service.
*
* Supported actions are `IssueCertificate` , `GetCertificate` , and `ListPermissions` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions)
* @param actions The private CA actions that can be performed by the designated AWS service.
*/
override fun actions(actions: List) {
cdkBuilder.actions(actions)
}
/**
* The private CA actions that can be performed by the designated AWS service.
*
* Supported actions are `IssueCertificate` , `GetCertificate` , and `ListPermissions` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions)
* @param actions The private CA actions that can be performed by the designated AWS service.
*/
override fun actions(vararg actions: String): Unit = actions(actions.toList())
/**
* The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-certificateauthorityarn)
* @param certificateAuthorityArn The Amazon Resource Number (ARN) of the private CA from which
* the permission was issued.
*/
override fun certificateAuthorityArn(certificateAuthorityArn: String) {
cdkBuilder.certificateAuthorityArn(certificateAuthorityArn)
}
/**
* The AWS service or entity that holds the permission.
*
* At this time, the only valid principal is `acm.amazonaws.com` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-principal)
* @param principal The AWS service or entity that holds the permission.
*/
override fun principal(principal: String) {
cdkBuilder.principal(principal)
}
/**
* The ID of the account that assigned the permission.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-sourceaccount)
* @param sourceAccount The ID of the account that assigned the permission.
*/
override fun sourceAccount(sourceAccount: String) {
cdkBuilder.sourceAccount(sourceAccount)
}
public fun build(): software.amazon.awscdk.services.acmpca.CfnPermission = cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.acmpca.CfnPermission.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnPermission {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnPermission(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.acmpca.CfnPermission):
CfnPermission = CfnPermission(cdkObject)
internal fun unwrap(wrapped: CfnPermission):
software.amazon.awscdk.services.acmpca.CfnPermission = wrapped.cdkObject as
software.amazon.awscdk.services.acmpca.CfnPermission
}
}