AWS Native is in preview. AWS Classic is fully supported.
aws-native.transfer.getAgreement
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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:
- Agreement
Id string A unique identifier for the agreement.
- Server
Id string A unique identifier for the server.
- Agreement
Id string A unique identifier for the agreement.
- Server
Id string A unique identifier for the server.
- agreement
Id String A unique identifier for the agreement.
- server
Id String A unique identifier for the server.
- agreement
Id string A unique identifier for the agreement.
- server
Id 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.
- agreement
Id String A unique identifier for the agreement.
- server
Id String A unique identifier for the server.
getAgreement Result
The following output properties are available:
- Access
Role string Specifies the access role for the agreement.
- Agreement
Id string A unique identifier for the agreement.
- Arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
- Base
Directory string Specifies the base directory for the agreement.
- Description string
A textual description for the agreement.
- Local
Profile stringId A unique identifier for the local profile.
- Partner
Profile stringId A unique identifier for the partner profile.
- Status
Pulumi.
Aws Native. Transfer. Agreement Status Specifies the status of the agreement.
- List<Pulumi.
Aws Native. Transfer. Outputs. Agreement Tag> Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- Access
Role string Specifies the access role for the agreement.
- Agreement
Id string A unique identifier for the agreement.
- Arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
- Base
Directory string Specifies the base directory for the agreement.
- Description string
A textual description for the agreement.
- Local
Profile stringId A unique identifier for the local profile.
- Partner
Profile stringId A unique identifier for the partner profile.
- Status
Agreement
Status Specifies the status of the agreement.
- []Agreement
Tag Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- access
Role String Specifies the access role for the agreement.
- agreement
Id String A unique identifier for the agreement.
- arn String
Specifies the unique Amazon Resource Name (ARN) for the agreement.
- base
Directory String Specifies the base directory for the agreement.
- description String
A textual description for the agreement.
- local
Profile StringId A unique identifier for the local profile.
- partner
Profile StringId A unique identifier for the partner profile.
- status
Agreement
Status Specifies the status of the agreement.
- List<Agreement
Tag> Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- access
Role string Specifies the access role for the agreement.
- agreement
Id string A unique identifier for the agreement.
- arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
- base
Directory string Specifies the base directory for the agreement.
- description string
A textual description for the agreement.
- local
Profile stringId A unique identifier for the local profile.
- partner
Profile stringId A unique identifier for the partner profile.
- status
Agreement
Status Specifies the status of the agreement.
- Agreement
Tag[] 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_ strid A unique identifier for the local profile.
- partner_
profile_ strid A unique identifier for the partner profile.
- status
Agreement
Status Specifies the status of the agreement.
- Sequence[Agreement
Tag] Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- access
Role String Specifies the access role for the agreement.
- agreement
Id String A unique identifier for the agreement.
- arn String
Specifies the unique Amazon Resource Name (ARN) for the agreement.
- base
Directory String Specifies the base directory for the agreement.
- description String
A textual description for the agreement.
- local
Profile StringId A unique identifier for the local profile.
- partner
Profile StringId A unique identifier for the partner profile.
- status "ACTIVE" | "INACTIVE"
Specifies the status of the agreement.
- 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.