software.amazon.awscdk.services.iam

Class ServicePrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.ServicePrincipal

All Implemented Interfaces:

IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:14.013Z")
 @Stability(value=Stable)
public class ServicePrincipal
extends PrincipalBase

An IAM principal that represents an AWS service (i.e. sqs.amazonaws.com).

Example:

 Role lambdaRole = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
         .description("Example role...")
         .build();
 Stream stream = Stream.Builder.create(this, "MyEncryptedStream")
         .encryption(StreamEncryption.KMS)
         .build();
 // give lambda permissions to read stream
 stream.grantRead(lambdaRole);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServicePrincipal.Builder A fluent builder for ServicePrincipal.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IAssumeRolePrincipal

IAssumeRolePrincipal.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IComparablePrincipal

IComparablePrincipal.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServicePrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ServicePrincipal(software.amazon.jsii.JsiiObjectRef objRef)
	ServicePrincipal(String service)
	ServicePrincipal(String service, ServicePrincipalOpts opts)

Method Summary

Modifier and Type	Method and Description
String	dedupeString() Return whether or not this principal is equal to the given principal.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
String	getService() AWS service (i.e.
static String	servicePrincipalName(String service) Translate the given service principal name based on the region it's used in.
String	toString() Returns a string representation of an object.

Methods inherited from class software.amazon.awscdk.services.iam.PrincipalBase

addToAssumeRolePolicy, addToPolicy, addToPrincipalPolicy, getAssumeRoleAction, getGrantPrincipal, getPrincipalAccount, toJSON, withConditions, withSessionTags

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServicePrincipal

protected ServicePrincipal(software.amazon.jsii.JsiiObjectRef objRef)

ServicePrincipal

protected ServicePrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ServicePrincipal

@Stability(value=Stable)
public ServicePrincipal(@NotNull
                                                 String service,
                                                 @Nullable
                                                 ServicePrincipalOpts opts)

Parameters:

service - AWS service (i.e. sqs.amazonaws.com). This parameter is required.

opts -

ServicePrincipal

@Stability(value=Stable)
public ServicePrincipal(@NotNull
                                                 String service)

Parameters:

service - AWS service (i.e. sqs.amazonaws.com). This parameter is required.

Method Detail

servicePrincipalName

@Stability(value=Stable)
 @NotNull
public static String servicePrincipalName(@NotNull
                                                                             String service)

Translate the given service principal name based on the region it's used in.

For example, for Chinese regions this may (depending on whether that's necessary for the given service principal) append .cn to the name.

The region-info module is used to obtain this information.

Example:

 String principalName = ServicePrincipal.servicePrincipalName("ec2.amazonaws.com");
 

Parameters:

service - This parameter is required.

dedupeString

@Stability(value=Stable)
 @Nullable
public String dedupeString()

Return whether or not this principal is equal to the given principal.

Specified by:

dedupeString in interface IComparablePrincipal

Specified by:

dedupeString in class PrincipalBase

toString

@Stability(value=Stable)
 @NotNull
public String toString()

Returns a string representation of an object.

Overrides:

toString in class PrincipalBase

getPolicyFragment

@Stability(value=Stable)
 @NotNull
public PrincipalPolicyFragment getPolicyFragment()

Return the policy fragment that identifies this principal in a Policy.

Specified by:

getPolicyFragment in interface IPrincipal

Specified by:

getPolicyFragment in class PrincipalBase

getService

@Stability(value=Stable)
 @NotNull
public String getService()

AWS service (i.e. sqs.amazonaws.com).