Package software.amazon.awscdk.services.iam

Class RoleProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.iam.RoleProps.Jsii$Proxy
All Implemented Interfaces:
RoleProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
RoleProps
@Stability(Stable) @Internal public static final class RoleProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RoleProps
An implementation for RoleProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(RoleProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the RoleProps.Builder.

  • Method Details

    • getAssumedBy

      public final IPrincipal getAssumedBy()
      Description copied from interface: RoleProps
      The IAM principal (i.e. new ServicePrincipal('sns.amazonaws.com')) which can assume this role.

      You can later modify the assume role policy document by accessing it via the assumeRolePolicy property.

      Specified by:
      getAssumedBy in interface RoleProps

    • getDescription

      public final String getDescription()
      Description copied from interface: RoleProps
      A description of the role.

      It can be up to 1000 characters long.

      Default: - No description.

      Specified by:
      getDescription in interface RoleProps

    • getExternalIds

      public final List<String> getExternalIds()
      Description copied from interface: RoleProps
      List of IDs that the role assumer needs to provide one of when assuming this role.

      If the configured and provided external IDs do not match, the AssumeRole operation will fail.

      Default: No external ID required

      Specified by:
      getExternalIds in interface RoleProps

    • getInlinePolicies

      public final Map<String,PolicyDocument> getInlinePolicies()
      Description copied from interface: RoleProps
      A list of named policies to inline into this role.

      These policies will be created with the role, whereas those added by addToPolicy are added using a separate CloudFormation resource (allowing a way around circular dependencies that could otherwise be introduced).

      Default: - No policy is inlined in the Role resource.

      Specified by:
      getInlinePolicies in interface RoleProps

    • getManagedPolicies

      public final List<IManagedPolicy> getManagedPolicies()
      Description copied from interface: RoleProps
      A list of managed policies associated with this role.

      You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

      Default: - No managed policies.

      Specified by:
      getManagedPolicies in interface RoleProps

    • getMaxSessionDuration

      public final Duration getMaxSessionDuration()
      Description copied from interface: RoleProps
      The maximum session duration that you want to set for the specified role.

      This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.

      Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.

      If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.

      Default: Duration.hours(1)

      Specified by:
      getMaxSessionDuration in interface RoleProps

    • getPath

      public final String getPath()
      Description copied from interface: RoleProps
      The path associated with this role.

      For information about IAM paths, see Friendly Names and Paths in IAM User Guide.

      Default: /

      Specified by:
      getPath in interface RoleProps

    • getPermissionsBoundary

      public final IManagedPolicy getPermissionsBoundary()
      Description copied from interface: RoleProps
      AWS supports permissions boundaries for IAM entities (users or roles).

      A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.

      Default: - No permissions boundary.

      Specified by:
      getPermissionsBoundary in interface RoleProps

    • getRoleName

      public final String getRoleName()
      Description copied from interface: RoleProps
      A name for the IAM role.

      For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.

      IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

      If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

      Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

      Specified by:
      getRoleName in interface RoleProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object