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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_provider_arnString

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

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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_tokenString

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.

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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

#descriptionString

The description of the .

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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_arnString

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 in the Amazon Web Services General Reference.

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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

#nameString

The name of the .

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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_optionsTypes::PortalOptions

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



718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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

#statusString

Specifies whether the application is enabled or disabled.

Returns:

  • (String)


718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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

#tagsArray<Types::Tag>

Specifies tags to be attached to the application.

Returns:



718
719
720
721
722
723
724
725
726
727
728
729
# File 'gems/aws-sdk-ssoadmin/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