CompositePrincipal Class
Represents a principal that has multiple types of principals.
A composite principal cannot have conditions. i.e. multiple ServicePrincipals that form a composite principal
Example
declare const vpc: ec2.Vpc;
const role = new iam.Role(this, 'RDSDirectoryServicesRole', {
assumedBy: new iam.CompositePrincipal(
new iam.ServicePrincipal('rds.amazonaws.com'),
new iam.ServicePrincipal('directoryservice.rds.amazonaws.com'),
),
managedPolicies: [
iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AmazonRDSDirectoryServiceAccess'),
],
});
const instance = new rds.DatabaseInstance(this, 'Instance', {
engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),
vpc,
domain: 'd-????????', // The ID of the domain for the instance to join.
domainRole: role, // Optional - will be create automatically if not provided.
});
# vpc: ec2.Vpc
role = iam.Role(self, "RDSDirectoryServicesRole",
assumed_by=iam.CompositePrincipal(
iam.ServicePrincipal("rds.amazonaws.com"),
iam.ServicePrincipal("directoryservice.rds.amazonaws.com")),
managed_policies=[
iam.ManagedPolicy.from_aws_managed_policy_name("service-role/AmazonRDSDirectoryServiceAccess")
]
)
instance = rds.DatabaseInstance(self, "Instance",
engine=rds.DatabaseInstanceEngine.mysql(version=rds.MysqlEngineVersion.VER_8_0_19),
vpc=vpc,
domain="d-????????", # The ID of the domain for the instance to join.
domain_role=role
)
Vpc vpc;
Role role = Role.Builder.create(this, "RDSDirectoryServicesRole")
.assumedBy(new CompositePrincipal(
new ServicePrincipal("rds.amazonaws.com"),
new ServicePrincipal("directoryservice.rds.amazonaws.com")))
.managedPolicies(List.of(ManagedPolicy.fromAwsManagedPolicyName("service-role/AmazonRDSDirectoryServiceAccess")))
.build();
DatabaseInstance instance = DatabaseInstance.Builder.create(this, "Instance")
.engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_19).build()))
.vpc(vpc)
.domain("d-????????") // The ID of the domain for the instance to join.
.domainRole(role)
.build();
// Install: dotnet add package Amazon.CDK.Lib
Vpc vpc;
var role = new Role(this, "RDSDirectoryServicesRole", new RoleProps {
AssumedBy = new CompositePrincipal(
new ServicePrincipal("rds.amazonaws.com"),
new ServicePrincipal("directoryservice.rds.amazonaws.com")),
ManagedPolicies = new [] { ManagedPolicy.FromAwsManagedPolicyName("service-role/AmazonRDSDirectoryServiceAccess") }
});
var instance = new DatabaseInstance(this, "Instance", new DatabaseInstanceProps {
Engine = DatabaseInstanceEngine.Mysql(new MySqlInstanceEngineProps { Version = MysqlEngineVersion.VER_8_0_19 }),
Vpc = vpc,
Domain = "d-????????", // The ID of the domain for the instance to join.
DomainRole = role
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc
role := iam.NewRole(this, jsii.String("RDSDirectoryServicesRole"), &RoleProps{
AssumedBy: iam.NewCompositePrincipal(
iam.NewServicePrincipal(jsii.String("rds.amazonaws.com")),
iam.NewServicePrincipal(jsii.String("directoryservice.rds.amazonaws.com"))),
ManagedPolicies: []IManagedPolicy{
iam.ManagedPolicy_FromAwsManagedPolicyName(jsii.String("service-role/AmazonRDSDirectoryServiceAccess")),
},
})
instance := rds.NewDatabaseInstance(this, jsii.String("Instance"), &DatabaseInstanceProps{
Engine: rds.DatabaseInstanceEngine_Mysql(&MySqlInstanceEngineProps{
Version: rds.MysqlEngineVersion_VER_8_0_19(),
}),
Vpc: Vpc,
Domain: jsii.String("d-????????"),
// The ID of the domain for the instance to join.
DomainRole: role,
})
Initializer
new CompositePrincipal(principals: IPrincipal)
CompositePrincipal(principals: IPrincipal)
new CompositePrincipal(IPrincipal principals)
new CompositePrincipal(IPrincipal principals)
NewCompositePrincipal(Principals IPrincipal)
Properties
assumeRoleActionstringassume_role_actionstrassumeRoleActionStringAssumeRoleActionstringAssumeRoleAction*string#grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#policyFragmentPrincipalPolicyFragmentpolicy_fragmentPrincipalPolicyFragmentpolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragment#principalAccountmay be undefinedstringprincipal_accountmay be undefinedstrprincipalAccountmay be undefinedStringPrincipalAccountmay be undefinedstringPrincipalAccountmay be undefined*string#Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.
principalsIPrincipal[]principalstyping.List[IPrincipal]principalsList<IPrincipal>PrincipalsIPrincipal[]Principals*[]IPrincipal#Methods
addPrincipals(...principals: IPrincipal[]): CompositePrincipal // chainabledef add_principals(self, principals: IPrincipal) -> CompositePrincipalpublic CompositePrincipal addPrincipals(IPrincipal principals)public CompositePrincipal AddPrincipals(IPrincipal principals)func AddPrincipals(Principals IPrincipal) CompositePrincipal#Composite principals cannot have conditions.
1 parameter
Parameters
principalsprincipalsprincipalsprincipalsPrincipals— IAM principals that will be added to the composite principal.
addToAssumeRolePolicy(doc: PolicyDocument): voiddef add_to_assume_role_policy(self, doc: PolicyDocument) -> Nonepublic void addToAssumeRolePolicy(PolicyDocument doc)public void AddToAssumeRolePolicy(PolicyDocument doc)func AddToAssumeRolePolicy(Doc PolicyDocument)#Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.
addToPolicy(statement: PolicyStatement): booleandef add_to_policy(self, statement: PolicyStatement) -> boolpublic Boolean addToPolicy(PolicyStatement statement)public bool AddToPolicy(PolicyStatement statement)func AddToPolicy(Statement PolicyStatement) *bool#addToPrincipalPolicy(_statement: PolicyStatement): AddToPrincipalPolicyResultdef add_to_principal_policy(self, _statement: PolicyStatement) -> AddToPrincipalPolicyResultpublic AddToPrincipalPolicyResult addToPrincipalPolicy(PolicyStatement _statement)public AddToPrincipalPolicyResult AddToPrincipalPolicy(PolicyStatement _statement)func AddToPrincipalPolicy(_statement PolicyStatement) AddToPrincipalPolicyResult#dedupeString(): stringdef dedupe_string(self, ) -> strpublic String dedupeString()public string DedupeString()func DedupeString() *string#toJSON(): { [key: string]: string[] }def to_json(self, ) -> typing.Mapping[str, typing.List[str]]public Map<String, List<String>> toJSON()public IDictionary<string, string[]> ToJSON()func ToJSON() *map[string]*[]*string#Used when JSON.stringify() is called
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#withConditions(conditions: { [key: string]: any }): PrincipalBasedef with_conditions(self, conditions: typing.Mapping[str, Any]) -> PrincipalBasepublic PrincipalBase withConditions(Map<String, Object> conditions)public PrincipalBase WithConditions(IDictionary<string, object> conditions)func WithConditions(Conditions *map[string]interface{}) PrincipalBase#When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.
returns
Returns: a new PrincipalWithConditions object.
withSessionTags(): PrincipalBasedef with_session_tags(self, ) -> PrincipalBasepublic PrincipalBase withSessionTags()public PrincipalBase WithSessionTags()func WithSessionTags() PrincipalBase#returns
Returns: a new SessionTagsPrincipal object.