awstransfer

Documentation

Index

• func CfnServer_CFN_RESOURCE_TYPE_NAME() *string
• func CfnServer_IsCfnElement(x interface{}) *bool
• func CfnServer_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnServer_IsConstruct(x interface{}) *bool
• func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
• func CfnUser_IsCfnElement(x interface{}) *bool
• func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnUser_IsConstruct(x interface{}) *bool
• func NewCfnServer_Override(c CfnServer, scope constructs.Construct, id *string, props *CfnServerProps)
• func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
• type CfnServer
  • func NewCfnServer(scope constructs.Construct, id *string, props *CfnServerProps) CfnServer
• type CfnServerProps
• type CfnServer_EndpointDetailsProperty
• type CfnServer_IdentityProviderDetailsProperty
• type CfnUser
  • func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser
• type CfnUserProps
• type CfnUser_HomeDirectoryMapEntryProperty
• type CfnUser_PosixProfileProperty

Functions

func CfnServer_CFN_RESOURCE_TYPE_NAME

func CfnServer_CFN_RESOURCE_TYPE_NAME() *string

func CfnServer_IsCfnElement

func CfnServer_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnServer_IsCfnResource

func CfnServer_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnServer_IsConstruct

func CfnServer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnUser_CFN_RESOURCE_TYPE_NAME

func CfnUser_CFN_RESOURCE_TYPE_NAME() *string

func CfnUser_IsCfnElement

func CfnUser_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnUser_IsCfnResource

func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnUser_IsConstruct

func CfnUser_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnServer_Override

func NewCfnServer_Override(c CfnServer, scope constructs.Construct, id *string, props *CfnServerProps)

Create a new `AWS::Transfer::Server`.

func NewCfnUser_Override

func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)

Create a new `AWS::Transfer::User`.

Types

type CfnServer

type CfnServer interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrServerId() *string
	Certificate() *string
	SetCertificate(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Domain() *string
	SetDomain(val *string)
	EndpointDetails() interface{}
	SetEndpointDetails(val interface{})
	EndpointType() *string
	SetEndpointType(val *string)
	IdentityProviderDetails() interface{}
	SetIdentityProviderDetails(val interface{})
	IdentityProviderType() *string
	SetIdentityProviderType(val *string)
	LoggingRole() *string
	SetLoggingRole(val *string)
	LogicalId() *string
	Node() constructs.Node
	Protocols() *[]*string
	SetProtocols(val *[]*string)
	Ref() *string
	SecurityPolicyName() *string
	SetSecurityPolicyName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Transfer::Server`.

func NewCfnServer

func NewCfnServer(scope constructs.Construct, id *string, props *CfnServerProps) CfnServer

Create a new `AWS::Transfer::Server`.

type CfnServerProps

type CfnServerProps struct {
	// `AWS::Transfer::Server.Certificate`.
	Certificate *string `json:"certificate"`
	// `AWS::Transfer::Server.Domain`.
	Domain *string `json:"domain"`
	// `AWS::Transfer::Server.EndpointDetails`.
	EndpointDetails interface{} `json:"endpointDetails"`
	// `AWS::Transfer::Server.EndpointType`.
	EndpointType *string `json:"endpointType"`
	// `AWS::Transfer::Server.IdentityProviderDetails`.
	IdentityProviderDetails interface{} `json:"identityProviderDetails"`
	// `AWS::Transfer::Server.IdentityProviderType`.
	IdentityProviderType *string `json:"identityProviderType"`
	// `AWS::Transfer::Server.LoggingRole`.
	LoggingRole *string `json:"loggingRole"`
	// `AWS::Transfer::Server.Protocols`.
	Protocols *[]*string `json:"protocols"`
	// `AWS::Transfer::Server.SecurityPolicyName`.
	SecurityPolicyName *string `json:"securityPolicyName"`
	// `AWS::Transfer::Server.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Transfer::Server`.

type CfnServer_EndpointDetailsProperty

type CfnServer_EndpointDetailsProperty struct {
	// `CfnServer.EndpointDetailsProperty.AddressAllocationIds`.
	AddressAllocationIds *[]*string `json:"addressAllocationIds"`
	// `CfnServer.EndpointDetailsProperty.SecurityGroupIds`.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// `CfnServer.EndpointDetailsProperty.SubnetIds`.
	SubnetIds *[]*string `json:"subnetIds"`
	// `CfnServer.EndpointDetailsProperty.VpcEndpointId`.
	VpcEndpointId *string `json:"vpcEndpointId"`
	// `CfnServer.EndpointDetailsProperty.VpcId`.
	VpcId *string `json:"vpcId"`
}

type CfnServer_IdentityProviderDetailsProperty

type CfnServer_IdentityProviderDetailsProperty struct {
	// `CfnServer.IdentityProviderDetailsProperty.InvocationRole`.
	InvocationRole *string `json:"invocationRole"`
	// `CfnServer.IdentityProviderDetailsProperty.Url`.
	Url *string `json:"url"`
}

type CfnUser

type CfnUser interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrServerId() *string
	AttrUserName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	HomeDirectory() *string
	SetHomeDirectory(val *string)
	HomeDirectoryMappings() interface{}
	SetHomeDirectoryMappings(val interface{})
	HomeDirectoryType() *string
	SetHomeDirectoryType(val *string)
	LogicalId() *string
	Node() constructs.Node
	Policy() *string
	SetPolicy(val *string)
	PosixProfile() interface{}
	SetPosixProfile(val interface{})
	Ref() *string
	Role() *string
	SetRole(val *string)
	ServerId() *string
	SetServerId(val *string)
	SshPublicKeys() *[]*string
	SetSshPublicKeys(val *[]*string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UserName() *string
	SetUserName(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Transfer::User`.

func NewCfnUser

func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser

Create a new `AWS::Transfer::User`.

type CfnUserProps

type CfnUserProps struct {
	// `AWS::Transfer::User.Role`.
	Role *string `json:"role"`
	// `AWS::Transfer::User.ServerId`.
	ServerId *string `json:"serverId"`
	// `AWS::Transfer::User.UserName`.
	UserName *string `json:"userName"`
	// `AWS::Transfer::User.HomeDirectory`.
	HomeDirectory *string `json:"homeDirectory"`
	// `AWS::Transfer::User.HomeDirectoryMappings`.
	HomeDirectoryMappings interface{} `json:"homeDirectoryMappings"`
	// `AWS::Transfer::User.HomeDirectoryType`.
	HomeDirectoryType *string `json:"homeDirectoryType"`
	// `AWS::Transfer::User.Policy`.
	Policy *string `json:"policy"`
	// `AWS::Transfer::User.PosixProfile`.
	PosixProfile interface{} `json:"posixProfile"`
	// `AWS::Transfer::User.SshPublicKeys`.
	SshPublicKeys *[]*string `json:"sshPublicKeys"`
	// `AWS::Transfer::User.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Transfer::User`.

type CfnUser_HomeDirectoryMapEntryProperty

type CfnUser_HomeDirectoryMapEntryProperty struct {
	// `CfnUser.HomeDirectoryMapEntryProperty.Entry`.
	Entry *string `json:"entry"`
	// `CfnUser.HomeDirectoryMapEntryProperty.Target`.
	Target *string `json:"target"`
}

type CfnUser_PosixProfileProperty

type CfnUser_PosixProfileProperty struct {
	// `CfnUser.PosixProfileProperty.Gid`.
	Gid *float64 `json:"gid"`
	// `CfnUser.PosixProfileProperty.Uid`.
	Uid *float64 `json:"uid"`
	// `CfnUser.PosixProfileProperty.SecondaryGids`.
	SecondaryGids interface{} `json:"secondaryGids"`
}