Class: Aws::SSOAdmin::Types::CreateApplicationRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSOAdmin::Types::CreateApplicationRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssoadmin/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_provider_arn ⇒ String

  The ARN of the application provider under which the operation will run.

• #client_token ⇒ String

  Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.

• #description ⇒ String

  The description of the .

• #instance_arn ⇒ String

  The ARN of the instance of IAM Identity Center under which the operation will run.

• #name ⇒ String

  The name of the .

• #portal_options ⇒ Types::PortalOptions

  A structure that describes the options for the portal associated with an application.

• #status ⇒ String

  Specifies whether the application is enabled or disabled.

• #tags ⇒ Array<Types::Tag>

  Specifies tags to be attached to the application.

Instance Attribute Details

#application_provider_arn ⇒ String

The ARN of the application provider under which the operation will run.

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a [UUID type of value].

If you don’t provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ‘ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the .

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_arn ⇒ String

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the *Amazon Web Services General Reference*.

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the .

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portal_options ⇒ Types::PortalOptions

A structure that describes the options for the portal associated with an application.

Returns:

• (Types::PortalOptions)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies whether the application is enabled or disabled.

Returns:

• (String)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Specifies tags to be attached to the application.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ssoadmin/types.rb', line 718

class CreateApplicationRequest < Struct.new(
  :application_provider_arn,
  :client_token,
  :description,
  :instance_arn,
  :name,
  :portal_options,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end