@pulumi/aws-native/datasync/getLocationSmb.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Resource Type definition for AWS::DataSync::LocationSMB.
 */
export declare function getLocationSmb(args: GetLocationSmbArgs, opts?: pulumi.InvokeOptions): Promise<GetLocationSmbResult>;
export interface GetLocationSmbArgs {
    /**
     * The Amazon Resource Name (ARN) of the SMB location that is created.
     */
    locationArn: string;
}
export interface GetLocationSmbResult {
    /**
     * The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
     */
    readonly agentArns?: string[];
    /**
     * The authentication mode used to determine identity of user.
     */
    readonly authenticationType?: enums.datasync.LocationSmbAuthenticationType;
    /**
     * Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
     *
     * > You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.
     */
    readonly cmkSecretConfig?: outputs.datasync.LocationSmbCmkSecretConfig;
    /**
     * Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
     *
     * > You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.
     */
    readonly customSecretConfig?: outputs.datasync.LocationSmbCustomSecretConfig;
    /**
     * Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
     */
    readonly dnsIpAddresses?: string[];
    /**
     * The name of the Windows domain that the SMB server belongs to.
     */
    readonly domain?: string;
    /**
     * Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
     */
    readonly kerberosPrincipal?: string;
    /**
     * The Amazon Resource Name (ARN) of the SMB location that is created.
     */
    readonly locationArn?: string;
    /**
     * The URL of the SMB location that was described.
     */
    readonly locationUri?: string;
    readonly managedSecretConfig?: outputs.datasync.LocationSmbManagedSecretConfig;
    /**
     * Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
     */
    readonly mountOptions?: outputs.datasync.LocationSmbMountOptions;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    readonly tags?: outputs.Tag[];
    /**
     * The user who can mount the share, has the permissions to access files and folders in the SMB share.
     */
    readonly user?: string;
}
/**
 * Resource Type definition for AWS::DataSync::LocationSMB.
 */
export declare function getLocationSmbOutput(args: GetLocationSmbOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLocationSmbResult>;
export interface GetLocationSmbOutputArgs {
    /**
     * The Amazon Resource Name (ARN) of the SMB location that is created.
     */
    locationArn: pulumi.Input<string>;
}