CfnProfile

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.rolesanywhere.CfnProfile

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.573Z")
public class CfnProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RolesAnywhere::Profile`.

Creates a profile , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile .

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.rolesanywhere.*;
 CfnProfile cfnProfile = CfnProfile.Builder.create(this, "MyCfnProfile")
         .name("name")
         .roleArns(List.of("roleArns"))
         // the properties below are optional
         .durationSeconds(123)
         .enabled(false)
         .managedPolicyArns(List.of("managedPolicyArns"))
         .requireInstanceProperties(false)
         .sessionPolicy("sessionPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnProfile.Builder
A fluent builder for CfnProfile.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnProfile.Builder` A fluent builder for `CfnProfile`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnProfile(Construct scope, java.lang.String id, CfnProfileProps props)` Create a new `AWS::RolesAnywhere::Profile`.
`protected`	`CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrProfileArn()` The ARN of the profile.
`java.lang.String`	`getAttrProfileId()` The unique primary identifier of the Profile.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Number`	`getDurationSeconds()` Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.
`java.lang.Object`	`getEnabled()` Indicates whether the profile is enabled.
`java.util.List<java.lang.String>`	`getManagedPolicyArns()` A list of managed policy ARNs that apply to the vended session credentials.
`java.lang.String`	`getName()` The name of the profile.
`java.lang.Object`	`getRequireInstanceProperties()` Specifies whether instance properties are required in temporary credential requests with this profile.
`java.util.List<java.lang.String>`	`getRoleArns()` A list of IAM role ARNs.
`java.lang.String`	`getSessionPolicy()` A session policy that applies to the trust boundary of the vended session credentials.
`TagManager`	`getTags()` The tags to attach to the profile.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDurationSeconds(java.lang.Number value)` Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.
`void`	`setEnabled(java.lang.Boolean value)` Indicates whether the profile is enabled.
`void`	`setEnabled(IResolvable value)` Indicates whether the profile is enabled.
`void`	`setManagedPolicyArns(java.util.List<java.lang.String> value)` A list of managed policy ARNs that apply to the vended session credentials.
`void`	`setName(java.lang.String value)` The name of the profile.
`void`	`setRequireInstanceProperties(java.lang.Boolean value)` Specifies whether instance properties are required in temporary credential requests with this profile.
`void`	`setRequireInstanceProperties(IResolvable value)` Specifies whether instance properties are required in temporary credential requests with this profile.
`void`	`setRoleArns(java.util.List<java.lang.String> value)` A list of IAM role ARNs.
`void`	`setSessionPolicy(java.lang.String value)` A session policy that applies to the trust boundary of the vended session credentials.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnProfile
```
protected CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnProfile
```
protected CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnProfile
```
public CfnProfile(Construct scope,
                  java.lang.String id,
                  CfnProfileProps props)
```
    Create a new `AWS::RolesAnywhere::Profile`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrProfileArn
```
public java.lang.String getAttrProfileArn()
```
    The ARN of the profile.
  - getAttrProfileId
```
public java.lang.String getAttrProfileId()
```
    The unique primary identifier of the Profile.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to attach to the profile.
  - getName
```
public java.lang.String getName()
```
    The name of the profile.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the profile.
  - getRoleArns
```
public java.util.List<java.lang.String> getRoleArns()
```
    A list of IAM role ARNs.
    During CreateSession , if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy.
  - setRoleArns
```
public void setRoleArns(java.util.List<java.lang.String> value)
```
    A list of IAM role ARNs.
    During CreateSession , if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy.
  - getDurationSeconds
```
public java.lang.Number getDurationSeconds()
```
    Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.
  - setDurationSeconds
```
public void setDurationSeconds(java.lang.Number value)
```
    Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.
  - getEnabled
```
public java.lang.Object getEnabled()
```
    Indicates whether the profile is enabled.
  - setEnabled
```
public void setEnabled(java.lang.Boolean value)
```
    Indicates whether the profile is enabled.
  - setEnabled
```
public void setEnabled(IResolvable value)
```
    Indicates whether the profile is enabled.
  - getManagedPolicyArns
```
public java.util.List<java.lang.String> getManagedPolicyArns()
```
    A list of managed policy ARNs that apply to the vended session credentials.
  - setManagedPolicyArns
```
public void setManagedPolicyArns(java.util.List<java.lang.String> value)
```
    A list of managed policy ARNs that apply to the vended session credentials.
  - getRequireInstanceProperties
```
public java.lang.Object getRequireInstanceProperties()
```
    Specifies whether instance properties are required in temporary credential requests with this profile.
  - setRequireInstanceProperties
```
public void setRequireInstanceProperties(java.lang.Boolean value)
```
    Specifies whether instance properties are required in temporary credential requests with this profile.
  - setRequireInstanceProperties
```
public void setRequireInstanceProperties(IResolvable value)
```
    Specifies whether instance properties are required in temporary credential requests with this profile.
  - getSessionPolicy
```
public java.lang.String getSessionPolicy()
```
    A session policy that applies to the trust boundary of the vended session credentials.
  - setSessionPolicy
```
public void setSessionPolicy(java.lang.String value)
```
    A session policy that applies to the trust boundary of the vended session credentials.

Class CfnProfile

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnProfile

CfnProfile

CfnProfile

Method Detail

inspect

renderProperties

getAttrProfileArn

getAttrProfileId

getCfnProperties

getTags

getName

setName

getRoleArns

setRoleArns

getDurationSeconds

setDurationSeconds

getEnabled

setEnabled

setEnabled

getManagedPolicyArns

setManagedPolicyArns

getRequireInstanceProperties

setRequireInstanceProperties

setRequireInstanceProperties

getSessionPolicy

setSessionPolicy