AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getAgreement

Resource Type definition for AWS::Transfer::Agreement

Using getAgreement

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgreement(args: GetAgreementArgs, opts?: InvokeOptions): Promise<GetAgreementResult>
function getAgreementOutput(args: GetAgreementOutputArgs, opts?: InvokeOptions): Output<GetAgreementResult>
def get_agreement(agreement_id: Optional[str] = None,
                  server_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAgreementResult
def get_agreement_output(agreement_id: Optional[pulumi.Input[str]] = None,
                  server_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAgreementResult]
func LookupAgreement(ctx *Context, args *LookupAgreementArgs, opts ...InvokeOption) (*LookupAgreementResult, error)
func LookupAgreementOutput(ctx *Context, args *LookupAgreementOutputArgs, opts ...InvokeOption) LookupAgreementResultOutput

> Note: This function is named LookupAgreement in the Go SDK.

public static class GetAgreement 
{
    public static Task<GetAgreementResult> InvokeAsync(GetAgreementArgs args, InvokeOptions? opts = null)
    public static Output<GetAgreementResult> Invoke(GetAgreementInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgreementResult> getAgreement(GetAgreementArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:transfer:getAgreement
  arguments:
    # arguments dictionary

The following arguments are supported:

AgreementId string

A unique identifier for the agreement.

ServerId string

A unique identifier for the server.

AgreementId string

A unique identifier for the agreement.

ServerId string

A unique identifier for the server.

agreementId String

A unique identifier for the agreement.

serverId String

A unique identifier for the server.

agreementId string

A unique identifier for the agreement.

serverId string

A unique identifier for the server.

agreement_id str

A unique identifier for the agreement.

server_id str

A unique identifier for the server.

agreementId String

A unique identifier for the agreement.

serverId String

A unique identifier for the server.

getAgreement Result

The following output properties are available:

AccessRole string

Specifies the access role for the agreement.

AgreementId string

A unique identifier for the agreement.

Arn string

Specifies the unique Amazon Resource Name (ARN) for the agreement.

BaseDirectory string

Specifies the base directory for the agreement.

Description string

A textual description for the agreement.

LocalProfileId string

A unique identifier for the local profile.

PartnerProfileId string

A unique identifier for the partner profile.

Status Pulumi.AwsNative.Transfer.AgreementStatus

Specifies the status of the agreement.

Tags List<Pulumi.AwsNative.Transfer.Outputs.AgreementTag>

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

AccessRole string

Specifies the access role for the agreement.

AgreementId string

A unique identifier for the agreement.

Arn string

Specifies the unique Amazon Resource Name (ARN) for the agreement.

BaseDirectory string

Specifies the base directory for the agreement.

Description string

A textual description for the agreement.

LocalProfileId string

A unique identifier for the local profile.

PartnerProfileId string

A unique identifier for the partner profile.

Status AgreementStatus

Specifies the status of the agreement.

Tags []AgreementTag

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

accessRole String

Specifies the access role for the agreement.

agreementId String

A unique identifier for the agreement.

arn String

Specifies the unique Amazon Resource Name (ARN) for the agreement.

baseDirectory String

Specifies the base directory for the agreement.

description String

A textual description for the agreement.

localProfileId String

A unique identifier for the local profile.

partnerProfileId String

A unique identifier for the partner profile.

status AgreementStatus

Specifies the status of the agreement.

tags List<AgreementTag>

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

accessRole string

Specifies the access role for the agreement.

agreementId string

A unique identifier for the agreement.

arn string

Specifies the unique Amazon Resource Name (ARN) for the agreement.

baseDirectory string

Specifies the base directory for the agreement.

description string

A textual description for the agreement.

localProfileId string

A unique identifier for the local profile.

partnerProfileId string

A unique identifier for the partner profile.

status AgreementStatus

Specifies the status of the agreement.

tags AgreementTag[]

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

access_role str

Specifies the access role for the agreement.

agreement_id str

A unique identifier for the agreement.

arn str

Specifies the unique Amazon Resource Name (ARN) for the agreement.

base_directory str

Specifies the base directory for the agreement.

description str

A textual description for the agreement.

local_profile_id str

A unique identifier for the local profile.

partner_profile_id str

A unique identifier for the partner profile.

status AgreementStatus

Specifies the status of the agreement.

tags Sequence[AgreementTag]

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

accessRole String

Specifies the access role for the agreement.

agreementId String

A unique identifier for the agreement.

arn String

Specifies the unique Amazon Resource Name (ARN) for the agreement.

baseDirectory String

Specifies the base directory for the agreement.

description String

A textual description for the agreement.

localProfileId String

A unique identifier for the local profile.

partnerProfileId String

A unique identifier for the partner profile.

status "ACTIVE" | "INACTIVE"

Specifies the status of the agreement.

tags List<Property Map>

Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

Supporting Types

AgreementStatus

AgreementTag

Key string

The name assigned to the tag that you create.

Value string

Contains one or more values that you assigned to the key name you create.

Key string

The name assigned to the tag that you create.

Value string

Contains one or more values that you assigned to the key name you create.

key String

The name assigned to the tag that you create.

value String

Contains one or more values that you assigned to the key name you create.

key string

The name assigned to the tag that you create.

value string

Contains one or more values that you assigned to the key name you create.

key str

The name assigned to the tag that you create.

value str

Contains one or more values that you assigned to the key name you create.

key String

The name assigned to the tag that you create.

value String

Contains one or more values that you assigned to the key name you create.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0