Package software.amazon.awscdk.services.rolesanywhere

Interface CfnProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:31.850Z")
@Stability(Stable)
public interface CfnProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProfile.

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.*;
 CfnProfileProps cfnProfileProps = CfnProfileProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProfileProps.Builder	A builder for CfnProfileProps
static final class	CfnProfileProps.Jsii$Proxy	An implementation for CfnProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnProfileProps.Builder	builder()
default Number	getDurationSeconds()	Sets the maximum number of seconds that vended temporary credentials through CreateSession will be valid for, between 900 and 3600.
default Object	getEnabled()	Indicates whether the profile is enabled.
default List<String>	getManagedPolicyArns()	A list of managed policy ARNs that apply to the vended session credentials.
String	getName()	The name of the profile.
default Object	getRequireInstanceProperties()	Specifies whether instance properties are required in temporary credential requests with this profile.
List<String>	getRoleArns()	A list of IAM role ARNs.
default String	getSessionPolicy()	A session policy that applies to the trust boundary of the vended session credentials.
default List<CfnTag>	getTags()	The tags to attach to the profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-name

getRoleArns

@Stability(Stable)
@NotNull
List<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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-rolearns

getDurationSeconds

@Stability(Stable)
@Nullable
default Number getDurationSeconds()

Sets the maximum number of seconds that vended temporary credentials through CreateSession will be valid for, between 900 and 3600.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-durationseconds

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Indicates whether the profile is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-enabled

getManagedPolicyArns

@Stability(Stable)
@Nullable
default List<String> getManagedPolicyArns()

A list of managed policy ARNs that apply to the vended session credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-managedpolicyarns

getRequireInstanceProperties

@Stability(Stable)
@Nullable
default Object getRequireInstanceProperties()

Specifies whether instance properties are required in temporary credential requests with this profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-requireinstanceproperties

getSessionPolicy

@Stability(Stable)
@Nullable
default String getSessionPolicy()

A session policy that applies to the trust boundary of the vended session credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-sessionpolicy

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to attach to the profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-tags

builder

@Stability(Stable)
static CfnProfileProps.Builder builder()

Returns:

a CfnProfileProps.Builder of CfnProfileProps