![JAR search and dependency download from the Maven repository](/logo.png)
io.cloudshiftdev.awscdk.cloud_assembly_schema.KeyContextQuery.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.cloud_assembly_schema
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.Map
/**
* Query input for looking up a KMS Key.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.cloud_assembly_schema.*;
* Object assumeRoleAdditionalOptions;
* KeyContextQuery keyContextQuery = KeyContextQuery.builder()
* .account("account")
* .aliasName("aliasName")
* .region("region")
* // the properties below are optional
* .assumeRoleAdditionalOptions(Map.of(
* "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
* .lookupRoleArn("lookupRoleArn")
* .lookupRoleExternalId("lookupRoleExternalId")
* .build();
* ```
*/
public interface KeyContextQuery : ContextLookupRoleOptions {
/**
* Alias name used to search the Key.
*/
public fun aliasName(): String
/**
* A builder for [KeyContextQuery]
*/
@CdkDslMarker
public interface Builder {
/**
* @param account Query account.
*/
public fun account(account: String)
/**
* @param aliasName Alias name used to search the Key.
*/
public fun aliasName(aliasName: String)
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the lookup
* role.
* * `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.
*/
public fun assumeRoleAdditionalOptions(assumeRoleAdditionalOptions: Map)
/**
* @param lookupRoleArn The ARN of the role that should be used to look up the missing values.
*/
public fun lookupRoleArn(lookupRoleArn: String)
/**
* @param lookupRoleExternalId The ExternalId that needs to be supplied while assuming this
* role.
*/
public fun lookupRoleExternalId(lookupRoleExternalId: String)
/**
* @param region Query region.
*/
public fun region(region: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery.Builder =
software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery.builder()
/**
* @param account Query account.
*/
override fun account(account: String) {
cdkBuilder.account(account)
}
/**
* @param aliasName Alias name used to search the Key.
*/
override fun aliasName(aliasName: String) {
cdkBuilder.aliasName(aliasName)
}
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the lookup
* role.
* * `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.
*/
override fun assumeRoleAdditionalOptions(assumeRoleAdditionalOptions: Map) {
cdkBuilder.assumeRoleAdditionalOptions(assumeRoleAdditionalOptions.mapValues{CdkObjectWrappers.unwrap(it.value)})
}
/**
* @param lookupRoleArn The ARN of the role that should be used to look up the missing values.
*/
override fun lookupRoleArn(lookupRoleArn: String) {
cdkBuilder.lookupRoleArn(lookupRoleArn)
}
/**
* @param lookupRoleExternalId The ExternalId that needs to be supplied while assuming this
* role.
*/
override fun lookupRoleExternalId(lookupRoleExternalId: String) {
cdkBuilder.lookupRoleExternalId(lookupRoleExternalId)
}
/**
* @param region Query region.
*/
override fun region(region: String) {
cdkBuilder.region(region)
}
public fun build(): software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery,
) : CdkObject(cdkObject),
KeyContextQuery {
/**
* Query account.
*/
override fun account(): String = unwrap(this).getAccount()
/**
* Alias name used to search the Key.
*/
override fun aliasName(): String = unwrap(this).getAliasName()
/**
* Additional options to pass to STS when assuming the lookup role.
*
* * `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.
*
* Default: - No additional options.
*
* [Documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property)
*/
override fun assumeRoleAdditionalOptions(): Map =
unwrap(this).getAssumeRoleAdditionalOptions() ?: emptyMap()
/**
* The ARN of the role that should be used to look up the missing values.
*
* Default: - None
*/
override fun lookupRoleArn(): String? = unwrap(this).getLookupRoleArn()
/**
* The ExternalId that needs to be supplied while assuming this role.
*
* Default: - No ExternalId will be supplied
*/
override fun lookupRoleExternalId(): String? = unwrap(this).getLookupRoleExternalId()
/**
* Query region.
*/
override fun region(): String = unwrap(this).getRegion()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): KeyContextQuery {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery):
KeyContextQuery = CdkObjectWrappers.wrap(cdkObject) as? KeyContextQuery ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: KeyContextQuery):
software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy