Class: Aws::StorageGateway::Types::AssociateFileSystemInput

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

Overview

Note:

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

{
  user_name: "DomainUserName", # required
  password: "DomainUserPassword", # required
  client_token: "ClientToken", # required
  gateway_arn: "GatewayARN", # required
  location_arn: "FileSystemLocationARN", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  audit_destination_arn: "AuditDestinationARN",
  cache_attributes: {
    cache_stale_timeout_in_seconds: 1,
  },
  endpoint_network_configuration: {
    ip_addresses: ["IPV4Address"],
  },
}

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_destination_arnString

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#cache_attributesTypes::CacheAttributes

The refresh cache information for the file share or FSx file systems.



494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#client_tokenString

A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#endpoint_network_configurationTypes::EndpointNetworkConfiguration

Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.



494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#gateway_arnString

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#location_arnString

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

The password of the user credential.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

Returns:



494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user_nameString

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

Returns:

  • (String)


494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 494

class AssociateFileSystemInput < Struct.new(
  :user_name,
  :password,
  :client_token,
  :gateway_arn,
  :location_arn,
  :tags,
  :audit_destination_arn,
  :cache_attributes,
  :endpoint_network_configuration)
  SENSITIVE = [:password]
  include Aws::Structure
end