S3Backend.AssumeRoleBase (opentofu-base-plugin 2.5.1 API)

org.ysb33r.gradle.opentofu.backends.S3Backend.AssumeRoleBase

```
static class S3Backend.AssumeRoleBase
extends Object
```
Base class for configuring assume roles with or without web identity.
Since:
2.0

Field Summary

Fields
Modifiers	Name	Description
`protected ConfigCacheSafeOperations`	`ccso`
`protected MapProperty<String, Object>`	`values`

Properties Summary

Properties
Type	Name and description
`Provider<java.util.Map<String, TokenValue>>`	`tokenProvider`

Constructor Summary

Constructors
Constructor and description
`protected AssumeRoleBase (Project tempProjectRef, String toplevelToken)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`policyARNs(Object[] items)` Sets a token called `assume_role_policy_arns`.
	`void`	`setDuration(String value)` Sets the duration for assuming the role.
	`void`	`setPolicy(java.util.Map<String, ?> policyValues)` Sets the policy for assuming the role
	`void`	`setPolicy(Provider<String> policy)` Sets a token called `assume_role_policy`.
	`void`	`setPolicy(String jsonPolicy)` Sets a token called `assume_role_policy`.
	`void`	`setPolicyARNs(Iterable<Object> items)` Sets a token called `assume_role_policy_arns`.
	`void`	`setRoleArn(Object value)` Sets a token called `role_arn`.
	`void`	`setSessionName(Object value)` Sets a token called `session_name`.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - protected final ConfigCacheSafeOperations ccso
  - protected final MapProperty<String, Object> values
- Property Detail
  - final Provider<java.util.Map<String, TokenValue>> tokenProvider
- Constructor Detail
  - protected AssumeRoleBase(Project tempProjectRef, String toplevelToken)
- Method Detail
  - void policyARNs(Object[] items)
    
    Sets a token called assume_role_policy_arns.
    Parameters:
    value - ARNs.
  - void setDuration(String value)
    
    Sets the duration for assuming the role.
    Parameters:
    value - See https://developer.hashicorp.com/terraform/language/backend/s3#duration for formats.
  - void setPolicy(java.util.Map<String, ?> policyValues)
    
    Sets the policy for assuming the role
    Parameters:
    value - Policy in the form of a map.
  - void setPolicy(Provider<String> policy)
    
    Sets a token called assume_role_policy.
    Parameters:
    value - Policy as a JSON string.
  - void setPolicy(String jsonPolicy)
    
    Sets a token called assume_role_policy.
    Parameters:
    jsonPolicy - Policy as a JSON string.
  - void setPolicyARNs(Iterable<Object> items)
    
    Sets a token called assume_role_policy_arns.
    Parameters:
    value - ARNs.
  - void setRoleArn(Object value)
    
    Sets a token called role_arn.
    Parameters:
    value - AWS ARN for assumed role.
  - void setSessionName(Object value)
    
    Sets a token called session_name.
    Parameters:
    value - AWS ARN for assumed role.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class S3Backend.AssumeRoleBase

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final ConfigCacheSafeOperations ccso

protected final MapProperty<String, Object> values

Property Detail

final Provider<java.util.Map<String, TokenValue>> tokenProvider

Constructor Detail

protected AssumeRoleBase(Project tempProjectRef, String toplevelToken)

Method Detail

void policyARNs(Object[] items)

void setDuration(String value)

void setPolicy(java.util.Map<String, ?> policyValues)

void setPolicy(Provider<String> policy)

void setPolicy(String jsonPolicy)

void setPolicyARNs(Iterable<Object> items)

void setRoleArn(Object value)

void setSessionName(Object value)