io.cloudshiftdev.awscdk.services.evidently.CfnSegment.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.evidently
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.ITaggable
import io.cloudshiftdev.awscdk.TagManager
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
/**
* Creates or updates a *segment* of your audience.
*
* A segment is a portion of your audience that share one or more characteristics. Examples could be
* Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other
* criteria that your application collects, such as age.
*
* Using a segment in an experiment limits that experiment to evaluate only the users who match the
* segment criteria. Using one or more segments in a launch allow you to define different traffic
* splits for the different audience segments.
*
* For more information about segment pattern syntax, see [Segment rule pattern
* syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax)
* .
*
* The pattern that you define for a segment is matched against the value of `evaluationContext` ,
* which is passed into Evidently in the
* [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html)
* operation, when Evidently assigns a feature variation to a user.
*
* 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.evidently.*;
* CfnSegment cfnSegment = CfnSegment.Builder.create(this, "MyCfnSegment")
* .name("name")
* // the properties below are optional
* .description("description")
* .pattern("pattern")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html)
*/
public open class CfnSegment(
cdkObject: software.amazon.awscdk.services.evidently.CfnSegment,
) : CfnResource(cdkObject),
IInspectable,
ITaggable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSegmentProps,
) :
this(software.amazon.awscdk.services.evidently.CfnSegment(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnSegmentProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSegmentProps.Builder.() -> Unit,
) : this(scope, id, CfnSegmentProps(props)
)
/**
* The ARN of the segment.
*
* For example, `arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment`
*/
public open fun attrArn(): String = unwrap(this).getAttrArn()
/**
* An optional description for this segment.
*/
public open fun description(): String? = unwrap(this).getDescription()
/**
* An optional description for this segment.
*/
public open fun description(`value`: String) {
unwrap(this).setDescription(`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))
}
/**
* A name for the segment.
*/
public open fun name(): String = unwrap(this).getName()
/**
* A name for the segment.
*/
public open fun name(`value`: String) {
unwrap(this).setName(`value`)
}
/**
* The pattern to use for the segment.
*/
public open fun pattern(): String? = unwrap(this).getPattern()
/**
* The pattern to use for the segment.
*/
public open fun pattern(`value`: String) {
unwrap(this).setPattern(`value`)
}
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun tags(): TagManager = unwrap(this).getTags().let(TagManager::wrap)
/**
* Assigns one or more tags (key-value pairs) to the feature.
*/
public open fun tagsRaw(): List = unwrap(this).getTagsRaw()?.map(CfnTag::wrap) ?:
emptyList()
/**
* Assigns one or more tags (key-value pairs) to the feature.
*/
public open fun tagsRaw(`value`: List) {
unwrap(this).setTagsRaw(`value`.map(CfnTag.Companion::unwrap))
}
/**
* Assigns one or more tags (key-value pairs) to the feature.
*/
public open fun tagsRaw(vararg `value`: CfnTag): Unit = tagsRaw(`value`.toList())
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.evidently.CfnSegment].
*/
@CdkDslMarker
public interface Builder {
/**
* An optional description for this segment.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-description)
* @param description An optional description for this segment.
*/
public fun description(description: String)
/**
* A name for the segment.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-name)
* @param name A name for the segment.
*/
public fun name(name: String)
/**
* The pattern to use for the segment.
*
* For more information about pattern syntax, see [Segment rule pattern
* syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-pattern)
* @param pattern The pattern to use for the segment.
*/
public fun pattern(pattern: String)
/**
* Assigns one or more tags (key-value pairs) to the feature.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user permission to access or change only resources with certain tag
* values.
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of
* characters.
*
* You can associate as many as 50 tags with a feature.
*
* For more information, see [Tagging AWS
* resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags)
* @param tags Assigns one or more tags (key-value pairs) to the feature.
*/
public fun tags(tags: List)
/**
* Assigns one or more tags (key-value pairs) to the feature.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user permission to access or change only resources with certain tag
* values.
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of
* characters.
*
* You can associate as many as 50 tags with a feature.
*
* For more information, see [Tagging AWS
* resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags)
* @param tags Assigns one or more tags (key-value pairs) to the feature.
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.evidently.CfnSegment.Builder =
software.amazon.awscdk.services.evidently.CfnSegment.Builder.create(scope, id)
/**
* An optional description for this segment.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-description)
* @param description An optional description for this segment.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* A name for the segment.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-name)
* @param name A name for the segment.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* The pattern to use for the segment.
*
* For more information about pattern syntax, see [Segment rule pattern
* syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-pattern)
* @param pattern The pattern to use for the segment.
*/
override fun pattern(pattern: String) {
cdkBuilder.pattern(pattern)
}
/**
* Assigns one or more tags (key-value pairs) to the feature.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user permission to access or change only resources with certain tag
* values.
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of
* characters.
*
* You can associate as many as 50 tags with a feature.
*
* For more information, see [Tagging AWS
* resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags)
* @param tags Assigns one or more tags (key-value pairs) to the feature.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* Assigns one or more tags (key-value pairs) to the feature.
*
* Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user permission to access or change only resources with certain tag
* values.
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of
* characters.
*
* You can associate as many as 50 tags with a feature.
*
* For more information, see [Tagging AWS
* resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags)
* @param tags Assigns one or more tags (key-value pairs) to the feature.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.evidently.CfnSegment = cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.evidently.CfnSegment.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnSegment {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnSegment(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.evidently.CfnSegment): CfnSegment =
CfnSegment(cdkObject)
internal fun unwrap(wrapped: CfnSegment): software.amazon.awscdk.services.evidently.CfnSegment =
wrapped.cdkObject as software.amazon.awscdk.services.evidently.CfnSegment
}
}