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.104.0 (build e79254c)",
           date="2025-01-10T21:56:58.677Z")
@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
         .acceptRoleSessionName(false)
         .attributeMappings(List.of(AttributeMappingProperty.builder()
                 .certificateField("certificateField")
                 .mappingRules(List.of(MappingRuleProperty.builder()
                         .specifier("specifier")
                         .build()))
                 .build()))
         .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 Object	getAcceptRoleSessionName()	Used to determine if a custom role session name will be accepted in a temporary credential request.
default Object	getAttributeMappings()	A mapping applied to the authenticating end-entity certificate.
default Number	getDurationSeconds()	The number of seconds vended session credentials will be valid for.
default Object	getEnabled()	The enabled status of the resource.
default List<String>	getManagedPolicyArns()	A list of managed policy ARNs.
String	getName()	The customer specified name of the resource.
default Object	getRequireInstanceProperties()	Specifies whether instance properties are required in CreateSession requests with this profile.
List<String>	getRoleArns()	A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.
default String	getSessionPolicy()	A session policy that will applied to the trust boundary of the vended session credentials.
default List<CfnTag>	getTags()	A list of Tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The customer specified name of the resource.

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 that can be assumed when this profile is specified in a CreateSession request.

See Also:

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

getAcceptRoleSessionName

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

Used to determine if a custom role session name will be accepted in a temporary credential request.

See Also:

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

getAttributeMappings

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

A mapping applied to the authenticating end-entity certificate.

See Also:

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

getDurationSeconds

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

The number of seconds vended session credentials will be valid for.

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()

The enabled status of the resource.

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.

Managed policies identified by this list will be applied 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 CreateSession 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 will applied 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()

A list of Tags.

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