io.cloudshiftdev.awscdk.services.cleanrooms.CfnMembershipProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.cleanrooms
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Properties for defining a `CfnMembership`.
*
* 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.cleanrooms.*;
* CfnMembershipProps cfnMembershipProps = CfnMembershipProps.builder()
* .collaborationIdentifier("collaborationIdentifier")
* .queryLogStatus("queryLogStatus")
* // the properties below are optional
* .defaultResultConfiguration(MembershipProtectedQueryResultConfigurationProperty.builder()
* .outputConfiguration(MembershipProtectedQueryOutputConfigurationProperty.builder()
* .s3(ProtectedQueryS3OutputConfigurationProperty.builder()
* .bucket("bucket")
* .resultFormat("resultFormat")
* // the properties below are optional
* .keyPrefix("keyPrefix")
* .build())
* .build())
* // the properties below are optional
* .roleArn("roleArn")
* .build())
* .paymentConfiguration(MembershipPaymentConfigurationProperty.builder()
* .queryCompute(MembershipQueryComputePaymentConfigProperty.builder()
* .isResponsible(false)
* .build())
* .build())
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html)
*/
public interface CfnMembershipProps {
/**
* The unique ID for the associated collaboration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-collaborationidentifier)
*/
public fun collaborationIdentifier(): String
/**
* The default protected query result configuration as specified by the member who can receive
* results.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-defaultresultconfiguration)
*/
public fun defaultResultConfiguration(): Any? = unwrap(this).getDefaultResultConfiguration()
/**
* The payment responsibilities accepted by the collaboration member.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-paymentconfiguration)
*/
public fun paymentConfiguration(): Any? = unwrap(this).getPaymentConfiguration()
/**
* An indicator as to whether query logging has been enabled or disabled for the membership.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-querylogstatus)
*/
public fun queryLogStatus(): String
/**
* An optional label that you can assign to a resource when you create it.
*
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* A builder for [CfnMembershipProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param collaborationIdentifier The unique ID for the associated collaboration.
*/
public fun collaborationIdentifier(collaborationIdentifier: String)
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
public fun defaultResultConfiguration(defaultResultConfiguration: IResolvable)
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
public
fun defaultResultConfiguration(defaultResultConfiguration: CfnMembership.MembershipProtectedQueryResultConfigurationProperty)
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("012db4d184f0a697c1ea154824cad0a173b6cb0e21adb37afcb6d7d25a436166")
public
fun defaultResultConfiguration(defaultResultConfiguration: CfnMembership.MembershipProtectedQueryResultConfigurationProperty.Builder.() -> Unit)
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
public fun paymentConfiguration(paymentConfiguration: IResolvable)
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
public
fun paymentConfiguration(paymentConfiguration: CfnMembership.MembershipPaymentConfigurationProperty)
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("eb7529328879513aabfb11b672a54ed19c59afcb6a9b90a17fed8bc2502a15e7")
public
fun paymentConfiguration(paymentConfiguration: CfnMembership.MembershipPaymentConfigurationProperty.Builder.() -> Unit)
/**
* @param queryLogStatus An indicator as to whether query logging has been enabled or disabled
* for the membership.
*/
public fun queryLogStatus(queryLogStatus: String)
/**
* @param tags An optional label that you can assign to a resource when you create it.
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*/
public fun tags(tags: List)
/**
* @param tags An optional label that you can assign to a resource when you create it.
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.cleanrooms.CfnMembershipProps.Builder =
software.amazon.awscdk.services.cleanrooms.CfnMembershipProps.builder()
/**
* @param collaborationIdentifier The unique ID for the associated collaboration.
*/
override fun collaborationIdentifier(collaborationIdentifier: String) {
cdkBuilder.collaborationIdentifier(collaborationIdentifier)
}
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
override fun defaultResultConfiguration(defaultResultConfiguration: IResolvable) {
cdkBuilder.defaultResultConfiguration(defaultResultConfiguration.let(IResolvable.Companion::unwrap))
}
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
override
fun defaultResultConfiguration(defaultResultConfiguration: CfnMembership.MembershipProtectedQueryResultConfigurationProperty) {
cdkBuilder.defaultResultConfiguration(defaultResultConfiguration.let(CfnMembership.MembershipProtectedQueryResultConfigurationProperty.Companion::unwrap))
}
/**
* @param defaultResultConfiguration The default protected query result configuration as
* specified by the member who can receive results.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("012db4d184f0a697c1ea154824cad0a173b6cb0e21adb37afcb6d7d25a436166")
override
fun defaultResultConfiguration(defaultResultConfiguration: CfnMembership.MembershipProtectedQueryResultConfigurationProperty.Builder.() -> Unit):
Unit =
defaultResultConfiguration(CfnMembership.MembershipProtectedQueryResultConfigurationProperty(defaultResultConfiguration))
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
override fun paymentConfiguration(paymentConfiguration: IResolvable) {
cdkBuilder.paymentConfiguration(paymentConfiguration.let(IResolvable.Companion::unwrap))
}
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
override
fun paymentConfiguration(paymentConfiguration: CfnMembership.MembershipPaymentConfigurationProperty) {
cdkBuilder.paymentConfiguration(paymentConfiguration.let(CfnMembership.MembershipPaymentConfigurationProperty.Companion::unwrap))
}
/**
* @param paymentConfiguration The payment responsibilities accepted by the collaboration
* member.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("eb7529328879513aabfb11b672a54ed19c59afcb6a9b90a17fed8bc2502a15e7")
override
fun paymentConfiguration(paymentConfiguration: CfnMembership.MembershipPaymentConfigurationProperty.Builder.() -> Unit):
Unit =
paymentConfiguration(CfnMembership.MembershipPaymentConfigurationProperty(paymentConfiguration))
/**
* @param queryLogStatus An indicator as to whether query logging has been enabled or disabled
* for the membership.
*/
override fun queryLogStatus(queryLogStatus: String) {
cdkBuilder.queryLogStatus(queryLogStatus)
}
/**
* @param tags An optional label that you can assign to a resource when you create it.
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags An optional label that you can assign to a resource when you create it.
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.cleanrooms.CfnMembershipProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.cleanrooms.CfnMembershipProps,
) : CdkObject(cdkObject),
CfnMembershipProps {
/**
* The unique ID for the associated collaboration.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-collaborationidentifier)
*/
override fun collaborationIdentifier(): String = unwrap(this).getCollaborationIdentifier()
/**
* The default protected query result configuration as specified by the member who can receive
* results.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-defaultresultconfiguration)
*/
override fun defaultResultConfiguration(): Any? = unwrap(this).getDefaultResultConfiguration()
/**
* The payment responsibilities accepted by the collaboration member.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-paymentconfiguration)
*/
override fun paymentConfiguration(): Any? = unwrap(this).getPaymentConfiguration()
/**
* An indicator as to whether query logging has been enabled or disabled for the membership.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-querylogstatus)
*/
override fun queryLogStatus(): String = unwrap(this).getQueryLogStatus()
/**
* An optional label that you can assign to a resource when you create it.
*
* Each tag consists of a key and an optional value, both of which you define. When you use
* tagging, you can also use tag-based access control in IAM policies to control access to this
* resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnMembershipProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.cleanrooms.CfnMembershipProps):
CfnMembershipProps = CdkObjectWrappers.wrap(cdkObject) as? CfnMembershipProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnMembershipProps):
software.amazon.awscdk.services.cleanrooms.CfnMembershipProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.cleanrooms.CfnMembershipProps
}
}