Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. transfer
  5. Agreement

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.Agreement

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Transfer::Agreement

    Create Agreement Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Agreement(name: string, args: AgreementArgs, opts?: CustomResourceOptions);
    @overload
def Agreement(resource_name: str,
              args: AgreementArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Agreement(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_role: Optional[str] = None,
              base_directory: Optional[str] = None,
              local_profile_id: Optional[str] = None,
              partner_profile_id: Optional[str] = None,
              server_id: Optional[str] = None,
              description: Optional[str] = None,
              status: Optional[AgreementStatus] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewAgreement(ctx *Context, name string, args AgreementArgs, opts ...ResourceOption) (*Agreement, error)
    public Agreement(string name, AgreementArgs args, CustomResourceOptions? opts = null)
    public Agreement(String name, AgreementArgs args)
public Agreement(String name, AgreementArgs args, CustomResourceOptions options)

    type: aws-native:transfer:Agreement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AgreementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgreementArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgreementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgreementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgreementArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const agreementResource = new aws_native.transfer.Agreement("agreementResource", {
    accessRole: "string",
    baseDirectory: "string",
    localProfileId: "string",
    partnerProfileId: "string",
    serverId: "string",
    description: "string",
    status: aws_native.transfer.AgreementStatus.Active,
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    Agreement Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Agreement resource accepts the following input properties:

    AccessRole string
    Specifies the access role for the agreement.
    BaseDirectory string
    Specifies the base directory for the agreement.
    LocalProfileId string
    A unique identifier for the local profile.
    PartnerProfileId string
    A unique identifier for the partner profile.
    ServerId string
    A unique identifier for the server.
    Description string
    A textual description for the agreement.
    Status Pulumi.AwsNative.Transfer.AgreementStatus
    Specifies the status of the agreement.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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.
    BaseDirectory string
    Specifies the base directory for the agreement.
    LocalProfileId string
    A unique identifier for the local profile.
    PartnerProfileId string
    A unique identifier for the partner profile.
    ServerId string
    A unique identifier for the server.
    Description string
    A textual description for the agreement.
    Status AgreementStatus
    Specifies the status of the agreement.
    Tags TagArgs
    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.
    baseDirectory String
    Specifies the base directory for the agreement.
    localProfileId String
    A unique identifier for the local profile.
    partnerProfileId String
    A unique identifier for the partner profile.
    serverId String
    A unique identifier for the server.
    description String
    A textual description for the agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags List<Tag>
    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.
    baseDirectory string
    Specifies the base directory for the agreement.
    localProfileId string
    A unique identifier for the local profile.
    partnerProfileId string
    A unique identifier for the partner profile.
    serverId string
    A unique identifier for the server.
    description string
    A textual description for the agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags 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.
    base_directory str
    Specifies the base directory 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.
    server_id str
    A unique identifier for the server.
    description str
    A textual description for the agreement.
    status AgreementStatus
    Specifies the status of the agreement.
    tags Sequence[TagArgs]
    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.
    baseDirectory String
    Specifies the base directory for the agreement.
    localProfileId String
    A unique identifier for the local profile.
    partnerProfileId String
    A unique identifier for the partner profile.
    serverId String
    A unique identifier for the server.
    description String
    A textual description for the agreement.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Agreement resource produces the following output properties:

    AgreementId string
    A unique identifier for the agreement.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    Id string
    The provider-assigned unique ID for this managed resource.
    AgreementId string
    A unique identifier for the agreement.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    Id string
    The provider-assigned unique ID for this managed resource.
    agreementId String
    A unique identifier for the agreement.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    id String
    The provider-assigned unique ID for this managed resource.
    agreementId string
    A unique identifier for the agreement.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    id string
    The provider-assigned unique ID for this managed resource.
    agreement_id str
    A unique identifier for the agreement.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    id str
    The provider-assigned unique ID for this managed resource.
    agreementId String
    A unique identifier for the agreement.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AgreementStatus, AgreementStatusArgs

    Active
    ACTIVE
    Inactive
    INACTIVE
    AgreementStatusActive
    ACTIVE
    AgreementStatusInactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    ACTIVE
    ACTIVE
    INACTIVE
    INACTIVE
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native