Class: Aws::LicenseManager::Types::CreateTokenRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb

Overview

Note:

When making an API call, you may pass CreateTokenRequest data as a hash:

{
  license_arn: "Arn", # required
  role_arns: ["Arn"],
  expiration_in_days: 1,
  token_properties: ["String"],
  client_token: "IdempotencyToken", # required
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Idempotency token, valid for 10 minutes.

Returns:

  • (String) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb', line 1011

class CreateTokenRequest < Struct.new(
  :license_arn,
  :role_arns,
  :expiration_in_days,
  :token_properties,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_in_days ⇒ Integer

Token expiration, in days, counted from token creation. The default is 365 days.

Returns:

  • (Integer) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb', line 1011

class CreateTokenRequest < Struct.new(
  :license_arn,
  :role_arns,
  :expiration_in_days,
  :token_properties,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#license_arn ⇒ String

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

Returns:

  • (String) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb', line 1011

class CreateTokenRequest < Struct.new(
  :license_arn,
  :role_arns,
  :expiration_in_days,
  :token_properties,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arns ⇒ Array<String>

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

Returns:

  • (Array<String>) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb', line 1011

class CreateTokenRequest < Struct.new(
  :license_arn,
  :role_arns,
  :expiration_in_days,
  :token_properties,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#token_properties ⇒ Array<String>

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

Returns:

  • (Array<String>) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/types.rb', line 1011

class CreateTokenRequest < Struct.new(
  :license_arn,
  :role_arns,
  :expiration_in_days,
  :token_properties,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end