Package software.amazon.awscdk.cloud_assembly_schema

Interface ContextLookupRoleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AmiContextQuery, AvailabilityZonesContextQuery, EndpointServiceAvailabilityZonesContextQuery, HostedZoneContextQuery, KeyContextQuery, LoadBalancerContextQuery, LoadBalancerFilter, LoadBalancerListenerContextQuery, SecurityGroupContextQuery, SSMParameterContextQuery, VpcContextQuery

All Known Implementing Classes:

AmiContextQuery.Jsii$Proxy, AvailabilityZonesContextQuery.Jsii$Proxy, ContextLookupRoleOptions.Jsii$Proxy, EndpointServiceAvailabilityZonesContextQuery.Jsii$Proxy, HostedZoneContextQuery.Jsii$Proxy, KeyContextQuery.Jsii$Proxy, LoadBalancerContextQuery.Jsii$Proxy, LoadBalancerFilter.Jsii$Proxy, LoadBalancerListenerContextQuery.Jsii$Proxy, SecurityGroupContextQuery.Jsii$Proxy, SSMParameterContextQuery.Jsii$Proxy, VpcContextQuery.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:10.989Z")
@Stability(Stable)
public interface ContextLookupRoleOptions
extends software.amazon.jsii.JsiiSerializable

Options for context lookup roles.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object assumeRoleAdditionalOptions;
 ContextLookupRoleOptions contextLookupRoleOptions = ContextLookupRoleOptions.builder()
         .account("account")
         .region("region")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .lookupRoleArn("lookupRoleArn")
         .lookupRoleExternalId("lookupRoleExternalId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ContextLookupRoleOptions.Builder	A builder for ContextLookupRoleOptions
static final class	ContextLookupRoleOptions.Jsii$Proxy	An implementation for ContextLookupRoleOptions

Method Summary

Modifier and Type	Method	Description
static ContextLookupRoleOptions.Builder	builder()
String	getAccount()	Query account.
default Map<String,Object>	getAssumeRoleAdditionalOptions()	Additional options to pass to STS when assuming the lookup role.
default String	getLookupRoleArn()	The ARN of the role that should be used to look up the missing values.
default String	getLookupRoleExternalId()	The ExternalId that needs to be supplied while assuming this role.
String	getRegion()	Query region.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccount

@Stability(Stable)
@NotNull
String getAccount()

Query account.

getRegion

@Stability(Stable)
@NotNull
String getRegion()

Query region.

getAssumeRoleAdditionalOptions

@Stability(Stable)
@Nullable
default Map<String,Object> getAssumeRoleAdditionalOptions()

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.

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

getLookupRoleArn

@Stability(Stable)
@Nullable
default String getLookupRoleArn()

The ARN of the role that should be used to look up the missing values.

Default: - None

getLookupRoleExternalId

@Stability(Stable)
@Nullable
default String getLookupRoleExternalId()

The ExternalId that needs to be supplied while assuming this role.

Default: - No ExternalId will be supplied

builder

@Stability(Stable)
static ContextLookupRoleOptions.Builder builder()

Returns:

a ContextLookupRoleOptions.Builder of ContextLookupRoleOptions