Package software.amazon.awscdk.services.iam

Interface ServicePrincipalOpts

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServicePrincipalOpts.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:17.004Z")
@Stability(Stable)
public interface ServicePrincipalOpts
extends software.amazon.jsii.JsiiSerializable

Options for a service principal.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object conditions;
 ServicePrincipalOpts servicePrincipalOpts = ServicePrincipalOpts.builder()
         .conditions(Map.of(
                 "conditionsKey", conditions))
         .region("region")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ServicePrincipalOpts.Builder	builder()
default Map<String,Object>	getConditions()	Additional conditions to add to the Service Principal.
default String	getRegion()	The region in which you want to reference the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConditions

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

Additional conditions to add to the Service Principal.

Default: - No conditions

getRegion

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

The region in which you want to reference the service.

This is only necessary for cross-region references to opt-in regions. In those cases, the region name needs to be included to reference the correct service principal. In all other cases, the global service principal name is sufficient.

This field behaves differently depending on whether the @aws-cdk/aws-iam:standardizedServicePrincipals flag is set or not:

• If the flag is set, the input service principal is assumed to be of the form SERVICE.amazonaws.com. That value will always be returned, unless the given region is an opt-in region and the service principal is rendered in a stack in a different region, in which case SERVICE.REGION.amazonaws.com will be rendered. Under this regime, there is no downside to always specifying the region property: it will be rendered only if necessary.
• If the flag is not set, the service principal will resolve to a single principal whose name comes from the @aws-cdk/region-info package, using the region to override the stack region. If there is no entry for this service principal in the database,, the input service name is returned literally. This is legacy behavior and is not recommended.

Default: - the resolving Stack's region.

builder

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

Returns:

a ServicePrincipalOpts.Builder of ServicePrincipalOpts