io.cloudshiftdev.awscdk.services.appmesh.CfnGatewayRouteProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.appmesh
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 `CfnGatewayRoute`.
*
* 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.appmesh.*;
* CfnGatewayRouteProps cfnGatewayRouteProps = CfnGatewayRouteProps.builder()
* .meshName("meshName")
* .spec(GatewayRouteSpecProperty.builder()
* .grpcRoute(GrpcGatewayRouteProperty.builder()
* .action(GrpcGatewayRouteActionProperty.builder()
* .target(GatewayRouteTargetProperty.builder()
* .virtualService(GatewayRouteVirtualServiceProperty.builder()
* .virtualServiceName("virtualServiceName")
* .build())
* // the properties below are optional
* .port(123)
* .build())
* // the properties below are optional
* .rewrite(GrpcGatewayRouteRewriteProperty.builder()
* .hostname(GatewayRouteHostnameRewriteProperty.builder()
* .defaultTargetHostname("defaultTargetHostname")
* .build())
* .build())
* .build())
* .match(GrpcGatewayRouteMatchProperty.builder()
* .hostname(GatewayRouteHostnameMatchProperty.builder()
* .exact("exact")
* .suffix("suffix")
* .build())
* .metadata(List.of(GrpcGatewayRouteMetadataProperty.builder()
* .name("name")
* // the properties below are optional
* .invert(false)
* .match(GatewayRouteMetadataMatchProperty.builder()
* .exact("exact")
* .prefix("prefix")
* .range(GatewayRouteRangeMatchProperty.builder()
* .end(123)
* .start(123)
* .build())
* .regex("regex")
* .suffix("suffix")
* .build())
* .build()))
* .port(123)
* .serviceName("serviceName")
* .build())
* .build())
* .http2Route(HttpGatewayRouteProperty.builder()
* .action(HttpGatewayRouteActionProperty.builder()
* .target(GatewayRouteTargetProperty.builder()
* .virtualService(GatewayRouteVirtualServiceProperty.builder()
* .virtualServiceName("virtualServiceName")
* .build())
* // the properties below are optional
* .port(123)
* .build())
* // the properties below are optional
* .rewrite(HttpGatewayRouteRewriteProperty.builder()
* .hostname(GatewayRouteHostnameRewriteProperty.builder()
* .defaultTargetHostname("defaultTargetHostname")
* .build())
* .path(HttpGatewayRoutePathRewriteProperty.builder()
* .exact("exact")
* .build())
* .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
* .defaultPrefix("defaultPrefix")
* .value("value")
* .build())
* .build())
* .build())
* .match(HttpGatewayRouteMatchProperty.builder()
* .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
* .name("name")
* // the properties below are optional
* .invert(false)
* .match(HttpGatewayRouteHeaderMatchProperty.builder()
* .exact("exact")
* .prefix("prefix")
* .range(GatewayRouteRangeMatchProperty.builder()
* .end(123)
* .start(123)
* .build())
* .regex("regex")
* .suffix("suffix")
* .build())
* .build()))
* .hostname(GatewayRouteHostnameMatchProperty.builder()
* .exact("exact")
* .suffix("suffix")
* .build())
* .method("method")
* .path(HttpPathMatchProperty.builder()
* .exact("exact")
* .regex("regex")
* .build())
* .port(123)
* .prefix("prefix")
* .queryParameters(List.of(QueryParameterProperty.builder()
* .name("name")
* // the properties below are optional
* .match(HttpQueryParameterMatchProperty.builder()
* .exact("exact")
* .build())
* .build()))
* .build())
* .build())
* .httpRoute(HttpGatewayRouteProperty.builder()
* .action(HttpGatewayRouteActionProperty.builder()
* .target(GatewayRouteTargetProperty.builder()
* .virtualService(GatewayRouteVirtualServiceProperty.builder()
* .virtualServiceName("virtualServiceName")
* .build())
* // the properties below are optional
* .port(123)
* .build())
* // the properties below are optional
* .rewrite(HttpGatewayRouteRewriteProperty.builder()
* .hostname(GatewayRouteHostnameRewriteProperty.builder()
* .defaultTargetHostname("defaultTargetHostname")
* .build())
* .path(HttpGatewayRoutePathRewriteProperty.builder()
* .exact("exact")
* .build())
* .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
* .defaultPrefix("defaultPrefix")
* .value("value")
* .build())
* .build())
* .build())
* .match(HttpGatewayRouteMatchProperty.builder()
* .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
* .name("name")
* // the properties below are optional
* .invert(false)
* .match(HttpGatewayRouteHeaderMatchProperty.builder()
* .exact("exact")
* .prefix("prefix")
* .range(GatewayRouteRangeMatchProperty.builder()
* .end(123)
* .start(123)
* .build())
* .regex("regex")
* .suffix("suffix")
* .build())
* .build()))
* .hostname(GatewayRouteHostnameMatchProperty.builder()
* .exact("exact")
* .suffix("suffix")
* .build())
* .method("method")
* .path(HttpPathMatchProperty.builder()
* .exact("exact")
* .regex("regex")
* .build())
* .port(123)
* .prefix("prefix")
* .queryParameters(List.of(QueryParameterProperty.builder()
* .name("name")
* // the properties below are optional
* .match(HttpQueryParameterMatchProperty.builder()
* .exact("exact")
* .build())
* .build()))
* .build())
* .build())
* .priority(123)
* .build())
* .virtualGatewayName("virtualGatewayName")
* // the properties below are optional
* .gatewayRouteName("gatewayRouteName")
* .meshOwner("meshOwner")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html)
*/
public interface CfnGatewayRouteProps {
/**
* The name of the gateway route.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename)
*/
public fun gatewayRouteName(): String? = unwrap(this).getGatewayRouteName()
/**
* The name of the service mesh that the resource resides in.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname)
*/
public fun meshName(): String
/**
* The AWS IAM account ID of the service mesh owner.
*
* If the account ID is not your own, then it's the ID of the account that shared the mesh with
* your account. For more information about mesh sharing, see [Working with shared
* meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner)
*/
public fun meshOwner(): String? = unwrap(this).getMeshOwner()
/**
* The specifications of the gateway route.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec)
*/
public fun spec(): Any
/**
* Optional metadata that you can apply to the gateway route to assist with categorization and
* organization.
*
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have a
* maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* The virtual gateway that the gateway route is associated with.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname)
*/
public fun virtualGatewayName(): String
/**
* A builder for [CfnGatewayRouteProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param gatewayRouteName The name of the gateway route.
*/
public fun gatewayRouteName(gatewayRouteName: String)
/**
* @param meshName The name of the service mesh that the resource resides in.
*/
public fun meshName(meshName: String)
/**
* @param meshOwner The AWS IAM account ID of the service mesh owner.
* If the account ID is not your own, then it's the ID of the account that shared the mesh with
* your account. For more information about mesh sharing, see [Working with shared
* meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) .
*/
public fun meshOwner(meshOwner: String)
/**
* @param spec The specifications of the gateway route.
*/
public fun spec(spec: IResolvable)
/**
* @param spec The specifications of the gateway route.
*/
public fun spec(spec: CfnGatewayRoute.GatewayRouteSpecProperty)
/**
* @param spec The specifications of the gateway route.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("8da30807f8dadb75945a17bec105643ee3428cf45f74eda39e826940fb7f993e")
public fun spec(spec: CfnGatewayRoute.GatewayRouteSpecProperty.Builder.() -> Unit)
/**
* @param tags Optional metadata that you can apply to the gateway route to assist with
* categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have
* a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*/
public fun tags(tags: List)
/**
* @param tags Optional metadata that you can apply to the gateway route to assist with
* categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have
* a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*/
public fun tags(vararg tags: CfnTag)
/**
* @param virtualGatewayName The virtual gateway that the gateway route is associated with.
*/
public fun virtualGatewayName(virtualGatewayName: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps.Builder =
software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps.builder()
/**
* @param gatewayRouteName The name of the gateway route.
*/
override fun gatewayRouteName(gatewayRouteName: String) {
cdkBuilder.gatewayRouteName(gatewayRouteName)
}
/**
* @param meshName The name of the service mesh that the resource resides in.
*/
override fun meshName(meshName: String) {
cdkBuilder.meshName(meshName)
}
/**
* @param meshOwner The AWS IAM account ID of the service mesh owner.
* If the account ID is not your own, then it's the ID of the account that shared the mesh with
* your account. For more information about mesh sharing, see [Working with shared
* meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) .
*/
override fun meshOwner(meshOwner: String) {
cdkBuilder.meshOwner(meshOwner)
}
/**
* @param spec The specifications of the gateway route.
*/
override fun spec(spec: IResolvable) {
cdkBuilder.spec(spec.let(IResolvable.Companion::unwrap))
}
/**
* @param spec The specifications of the gateway route.
*/
override fun spec(spec: CfnGatewayRoute.GatewayRouteSpecProperty) {
cdkBuilder.spec(spec.let(CfnGatewayRoute.GatewayRouteSpecProperty.Companion::unwrap))
}
/**
* @param spec The specifications of the gateway route.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("8da30807f8dadb75945a17bec105643ee3428cf45f74eda39e826940fb7f993e")
override fun spec(spec: CfnGatewayRoute.GatewayRouteSpecProperty.Builder.() -> Unit): Unit =
spec(CfnGatewayRoute.GatewayRouteSpecProperty(spec))
/**
* @param tags Optional metadata that you can apply to the gateway route to assist with
* categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have
* a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags Optional metadata that you can apply to the gateway route to assist with
* categorization and organization.
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have
* a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
/**
* @param virtualGatewayName The virtual gateway that the gateway route is associated with.
*/
override fun virtualGatewayName(virtualGatewayName: String) {
cdkBuilder.virtualGatewayName(virtualGatewayName)
}
public fun build(): software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps,
) : CdkObject(cdkObject),
CfnGatewayRouteProps {
/**
* The name of the gateway route.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename)
*/
override fun gatewayRouteName(): String? = unwrap(this).getGatewayRouteName()
/**
* The name of the service mesh that the resource resides in.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname)
*/
override fun meshName(): String = unwrap(this).getMeshName()
/**
* The AWS IAM account ID of the service mesh owner.
*
* If the account ID is not your own, then it's the ID of the account that shared the mesh with
* your account. For more information about mesh sharing, see [Working with shared
* meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner)
*/
override fun meshOwner(): String? = unwrap(this).getMeshOwner()
/**
* The specifications of the gateway route.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec)
*/
override fun spec(): Any = unwrap(this).getSpec()
/**
* Optional metadata that you can apply to the gateway route to assist with categorization and
* organization.
*
* Each tag consists of a key and an optional value, both of which you define. Tag keys can have
* a maximum character length of 128 characters, and tag values can have a maximum length of 256
* characters.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* The virtual gateway that the gateway route is associated with.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname)
*/
override fun virtualGatewayName(): String = unwrap(this).getVirtualGatewayName()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnGatewayRouteProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps):
CfnGatewayRouteProps = CdkObjectWrappers.wrap(cdkObject) as? CfnGatewayRouteProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnGatewayRouteProps):
software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.appmesh.CfnGatewayRouteProps
}
}