package awsiam import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdk/v2/awsiam/internal" "github.com/aws/constructs-go/constructs/v10" ) // An IAM role that only gets attached to the construct tree once it gets used, not before. // // This construct can be used to simplify logic in other constructs // which need to create a role but only if certain configurations occur // (such as when AutoScaling is configured). The role can be configured in one // place, but if it never gets used it doesn't get instantiated and will // not be synthesized or deployed. // // Example: // // The code below shows an example of how to instantiate this type. // // The values are placeholders you should change. // import cdk "github.com/aws/aws-cdk-go/awscdk" // import "github.com/aws/aws-cdk-go/awscdk" // // var managedPolicy managedPolicy // var policyDocument policyDocument // var principal iPrincipal // // lazyRole := awscdk.Aws_iam.NewLazyRole(this, jsii.String("MyLazyRole"), &LazyRoleProps{ // AssumedBy: principal, // // // the properties below are optional // Description: jsii.String("description"), // ExternalIds: []*string{ // jsii.String("externalIds"), // }, // InlinePolicies: map[string]*policyDocument{ // "inlinePoliciesKey": policyDocument, // }, // ManagedPolicies: []iManagedPolicy{ // managedPolicy, // }, // MaxSessionDuration: cdk.Duration_Minutes(jsii.Number(30)), // Path: jsii.String("path"), // PermissionsBoundary: managedPolicy, // RoleName: jsii.String("roleName"), // }) // type LazyRole interface { awscdk.Resource IRole // When this Principal is used in an AssumeRole policy, the action to use. AssumeRoleAction() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *awscdk.ResourceEnvironment // The principal to grant permissions to. GrantPrincipal() IPrincipal // The tree node. Node() constructs.Node // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. PhysicalName() *string // Return the policy fragment that identifies this principal in a Policy. PolicyFragment() PrincipalPolicyFragment // The AWS account ID of this principal. // // 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. PrincipalAccount() *string // Returns the ARN of this role. RoleArn() *string // Returns the stable and unique string identifying the role (i.e. AIDAJQABLZS4A3QDU576Q). RoleId() *string // Returns the name of this role. RoleName() *string // The stack in which this resource is defined. Stack() awscdk.Stack // Attaches a managed policy to this role. AddManagedPolicy(policy IManagedPolicy) // Add to the policy of this principal. AddToPolicy(statement PolicyStatement) *bool // Adds a permission to the role's default policy document. // // If there is no default policy attached to this role, it will be created. AddToPrincipalPolicy(statement PolicyStatement) *AddToPrincipalPolicyResult // Apply the given removal policy to this resource. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Attaches a policy to this role. AttachInlinePolicy(policy Policy) GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. GetResourceNameAttribute(nameAttr *string) *string // Grant the actions defined in actions to the identity Principal on this resource. Grant(identity IPrincipal, actions ...*string) Grant // Grant permissions to the given principal to assume this role. GrantAssumeRole(identity IPrincipal) Grant // Grant permissions to the given principal to pass this role. GrantPassRole(identity IPrincipal) Grant // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for LazyRole type jsiiProxy_LazyRole struct { internal.Type__awscdkResource jsiiProxy_IRole } func (j *jsiiProxy_LazyRole) AssumeRoleAction() *string { var returns *string _jsii_.Get( j, "assumeRoleAction", &returns, ) return returns } func (j *jsiiProxy_LazyRole) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_LazyRole) GrantPrincipal() IPrincipal { var returns IPrincipal _jsii_.Get( j, "grantPrincipal", &returns, ) return returns } func (j *jsiiProxy_LazyRole) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_LazyRole) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_LazyRole) PolicyFragment() PrincipalPolicyFragment { var returns PrincipalPolicyFragment _jsii_.Get( j, "policyFragment", &returns, ) return returns } func (j *jsiiProxy_LazyRole) PrincipalAccount() *string { var returns *string _jsii_.Get( j, "principalAccount", &returns, ) return returns } func (j *jsiiProxy_LazyRole) RoleArn() *string { var returns *string _jsii_.Get( j, "roleArn", &returns, ) return returns } func (j *jsiiProxy_LazyRole) RoleId() *string { var returns *string _jsii_.Get( j, "roleId", &returns, ) return returns } func (j *jsiiProxy_LazyRole) RoleName() *string { var returns *string _jsii_.Get( j, "roleName", &returns, ) return returns } func (j *jsiiProxy_LazyRole) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func NewLazyRole(scope constructs.Construct, id *string, props *LazyRoleProps) LazyRole { _init_.Initialize() if err := validateNewLazyRoleParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_LazyRole{} _jsii_.Create( "aws-cdk-lib.aws_iam.LazyRole", []interface{}{scope, id, props}, &j, ) return &j } func NewLazyRole_Override(l LazyRole, scope constructs.Construct, id *string, props *LazyRoleProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_iam.LazyRole", []interface{}{scope, id, props}, l, ) } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. func LazyRole_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateLazyRole_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_iam.LazyRole", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func LazyRole_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateLazyRole_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_iam.LazyRole", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func LazyRole_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateLazyRole_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_iam.LazyRole", "isResource", []interface{}{construct}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) AddManagedPolicy(policy IManagedPolicy) { if err := l.validateAddManagedPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( l, "addManagedPolicy", []interface{}{policy}, ) } func (l *jsiiProxy_LazyRole) AddToPolicy(statement PolicyStatement) *bool { if err := l.validateAddToPolicyParameters(statement); err != nil { panic(err) } var returns *bool _jsii_.Invoke( l, "addToPolicy", []interface{}{statement}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) AddToPrincipalPolicy(statement PolicyStatement) *AddToPrincipalPolicyResult { if err := l.validateAddToPrincipalPolicyParameters(statement); err != nil { panic(err) } var returns *AddToPrincipalPolicyResult _jsii_.Invoke( l, "addToPrincipalPolicy", []interface{}{statement}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := l.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( l, "applyRemovalPolicy", []interface{}{policy}, ) } func (l *jsiiProxy_LazyRole) AttachInlinePolicy(policy Policy) { if err := l.validateAttachInlinePolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( l, "attachInlinePolicy", []interface{}{policy}, ) } func (l *jsiiProxy_LazyRole) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( l, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (l *jsiiProxy_LazyRole) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := l.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( l, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) GetResourceNameAttribute(nameAttr *string) *string { if err := l.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( l, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) Grant(identity IPrincipal, actions ...*string) Grant { if err := l.validateGrantParameters(identity); err != nil { panic(err) } args := []interface{}{identity} for _, a := range actions { args = append(args, a) } var returns Grant _jsii_.Invoke( l, "grant", args, &returns, ) return returns } func (l *jsiiProxy_LazyRole) GrantAssumeRole(identity IPrincipal) Grant { if err := l.validateGrantAssumeRoleParameters(identity); err != nil { panic(err) } var returns Grant _jsii_.Invoke( l, "grantAssumeRole", []interface{}{identity}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) GrantPassRole(identity IPrincipal) Grant { if err := l.validateGrantPassRoleParameters(identity); err != nil { panic(err) } var returns Grant _jsii_.Invoke( l, "grantPassRole", []interface{}{identity}, &returns, ) return returns } func (l *jsiiProxy_LazyRole) ToString() *string { var returns *string _jsii_.Invoke( l, "toString", nil, // no parameters &returns, ) return returns }