io.cloudshiftdev.awscdk.services.ecs.CfnCapacityProviderProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ecs
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 `CfnCapacityProvider`.
*
* 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.ecs.*;
* CfnCapacityProviderProps cfnCapacityProviderProps = CfnCapacityProviderProps.builder()
* .autoScalingGroupProvider(AutoScalingGroupProviderProperty.builder()
* .autoScalingGroupArn("autoScalingGroupArn")
* // the properties below are optional
* .managedDraining("managedDraining")
* .managedScaling(ManagedScalingProperty.builder()
* .instanceWarmupPeriod(123)
* .maximumScalingStepSize(123)
* .minimumScalingStepSize(123)
* .status("status")
* .targetCapacity(123)
* .build())
* .managedTerminationProtection("managedTerminationProtection")
* .build())
* // the properties below are optional
* .name("name")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html)
*/
public interface CfnCapacityProviderProps {
/**
* The Auto Scaling group settings for the capacity provider.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider)
*/
public fun autoScalingGroupProvider(): Any
/**
* The name of the capacity provider.
*
* If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is
* specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name)
*/
public fun name(): String? = unwrap(this).getName()
/**
* The metadata that you apply to the capacity provider to help you categorize and organize it.
*
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* A builder for [CfnCapacityProviderProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
public fun autoScalingGroupProvider(autoScalingGroupProvider: IResolvable)
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
public
fun autoScalingGroupProvider(autoScalingGroupProvider: CfnCapacityProvider.AutoScalingGroupProviderProperty)
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("7fc44dc003eac75329c00cde7b7197884272f4d231cfb1a2efc6554d839cd80f")
public
fun autoScalingGroupProvider(autoScalingGroupProvider: CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder.() -> Unit)
/**
* @param name The name of the capacity provider.
* If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is
* specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.
*/
public fun name(name: String)
/**
* @param tags The metadata that you apply to the capacity provider to help you categorize and
* organize it.
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*/
public fun tags(tags: List)
/**
* @param tags The metadata that you apply to the capacity provider to help you categorize and
* organize it.
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.ecs.CfnCapacityProviderProps.Builder =
software.amazon.awscdk.services.ecs.CfnCapacityProviderProps.builder()
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
override fun autoScalingGroupProvider(autoScalingGroupProvider: IResolvable) {
cdkBuilder.autoScalingGroupProvider(autoScalingGroupProvider.let(IResolvable.Companion::unwrap))
}
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
override
fun autoScalingGroupProvider(autoScalingGroupProvider: CfnCapacityProvider.AutoScalingGroupProviderProperty) {
cdkBuilder.autoScalingGroupProvider(autoScalingGroupProvider.let(CfnCapacityProvider.AutoScalingGroupProviderProperty.Companion::unwrap))
}
/**
* @param autoScalingGroupProvider The Auto Scaling group settings for the capacity provider.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("7fc44dc003eac75329c00cde7b7197884272f4d231cfb1a2efc6554d839cd80f")
override
fun autoScalingGroupProvider(autoScalingGroupProvider: CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder.() -> Unit):
Unit =
autoScalingGroupProvider(CfnCapacityProvider.AutoScalingGroupProviderProperty(autoScalingGroupProvider))
/**
* @param name The name of the capacity provider.
* If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is
* specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param tags The metadata that you apply to the capacity provider to help you categorize and
* organize it.
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags The metadata that you apply to the capacity provider to help you categorize and
* organize it.
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.ecs.CfnCapacityProviderProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ecs.CfnCapacityProviderProps,
) : CdkObject(cdkObject),
CfnCapacityProviderProps {
/**
* The Auto Scaling group settings for the capacity provider.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider)
*/
override fun autoScalingGroupProvider(): Any = unwrap(this).getAutoScalingGroupProvider()
/**
* The name of the capacity provider.
*
* If a name is specified, it cannot start with `aws` , `ecs` , or `fargate` . If no name is
* specified, a default name in the `CFNStackName-CFNResourceName-RandomString` format is used.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name)
*/
override fun name(): String? = unwrap(this).getName()
/**
* The metadata that you apply to the capacity provider to help you categorize and organize it.
*
* Each tag consists of a key and an optional value. You define both.
*
* The following basic restrictions apply to tags:
*
* * Maximum number of tags per resource - 50
* * For each resource, each tag key must be unique, and each tag key can have only one value.
* * Maximum key length - 128 Unicode characters in UTF-8
* * Maximum value length - 256 Unicode characters in UTF-8
* * If your tagging schema is used across multiple services and resources, remember that other
* services may have restrictions on allowed characters. Generally allowed characters are: letters,
* numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnCapacityProviderProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.ecs.CfnCapacityProviderProps):
CfnCapacityProviderProps = CdkObjectWrappers.wrap(cdkObject) as? CfnCapacityProviderProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnCapacityProviderProps):
software.amazon.awscdk.services.ecs.CfnCapacityProviderProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.ecs.CfnCapacityProviderProps
}
}