Documentation
¶
Index ¶
- func CfnApprovalTeam_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApprovalTeam_IsCfnElement(x interface{}) *bool
- func CfnApprovalTeam_IsCfnResource(x interface{}) *bool
- func CfnApprovalTeam_IsConstruct(x interface{}) *bool
- func CfnIdentitySource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdentitySource_IsCfnElement(x interface{}) *bool
- func CfnIdentitySource_IsCfnResource(x interface{}) *bool
- func CfnIdentitySource_IsConstruct(x interface{}) *bool
- func NewCfnApprovalTeam_Override(c CfnApprovalTeam, scope constructs.Construct, id *string, ...)
- func NewCfnIdentitySource_Override(c CfnIdentitySource, scope constructs.Construct, id *string, ...)
- type CfnApprovalTeam
- type CfnApprovalTeamProps
- type CfnApprovalTeam_ApprovalStrategyProperty
- type CfnApprovalTeam_ApproverProperty
- type CfnApprovalTeam_MofNApprovalStrategyProperty
- type CfnApprovalTeam_PolicyProperty
- type CfnIdentitySource
- type CfnIdentitySourceProps
- type CfnIdentitySource_IamIdentityCenterProperty
- type CfnIdentitySource_IdentitySourceParametersProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApprovalTeam_CFN_RESOURCE_TYPE_NAME ¶
func CfnApprovalTeam_CFN_RESOURCE_TYPE_NAME() *string
func CfnApprovalTeam_IsCfnElement ¶
func CfnApprovalTeam_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.
func CfnApprovalTeam_IsCfnResource ¶
func CfnApprovalTeam_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApprovalTeam_IsConstruct ¶
func CfnApprovalTeam_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnIdentitySource_CFN_RESOURCE_TYPE_NAME ¶
func CfnIdentitySource_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdentitySource_IsCfnElement ¶
func CfnIdentitySource_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.
func CfnIdentitySource_IsCfnResource ¶
func CfnIdentitySource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdentitySource_IsConstruct ¶
func CfnIdentitySource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnApprovalTeam_Override ¶
func NewCfnApprovalTeam_Override(c CfnApprovalTeam, scope constructs.Construct, id *string, props *CfnApprovalTeamProps)
Create a new `AWS::MPA::ApprovalTeam`.
func NewCfnIdentitySource_Override ¶
func NewCfnIdentitySource_Override(c CfnIdentitySource, scope constructs.Construct, id *string, props *CfnIdentitySourceProps)
Create a new `AWS::MPA::IdentitySource`.
Types ¶
type CfnApprovalTeam ¶
type CfnApprovalTeam interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmpa.IApprovalTeamRef
awscdk.ITaggableV2
// Contains details for how an approval team grants approval.
ApprovalStrategy() interface{}
SetApprovalStrategy(val interface{})
// A reference to a ApprovalTeam resource.
ApprovalTeamRef() *interfacesawsmpa.ApprovalTeamReference
// Contains details for an approver.
Approvers() interface{}
SetApprovers(val interface{})
// Amazon Resource Name (ARN) for the team.
AttrArn() *string
// Timestamp when the team was created.
AttrCreationTime() *string
// Timestamp when the team was last updated.
AttrLastUpdateTime() *string
// Total number of approvers in the team.
AttrNumberOfApprovers() *float64
// Status for the team.
//
// For more information, see [Team health](https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html) in the *Multi-party approval User Guide* .
AttrStatus() *string
// Status code for the team.
//
// For more information, see [Team health](https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html) in the *Multi-party approval User Guide* .
AttrStatusCode() *string
// Message describing the status for the team.
AttrStatusMessage() *string
// Timestamp when the team was last updated.
AttrUpdateSessionArn() *string
// Version ID for the team.
AttrVersionId() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Description for the team.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// Name of the team.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Contains details for a policy.
Policies() interface{}
SetPolicies(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags that you have added to the specified resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a new approval team.
For more information, see [Approval team](https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html) in the *Multi-party approval User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApprovalTeam := awscdk.Aws_mpa.NewCfnApprovalTeam(this, jsii.String("MyCfnApprovalTeam"), &CfnApprovalTeamProps{
ApprovalStrategy: &ApprovalStrategyProperty{
MofN: &MofNApprovalStrategyProperty{
MinApprovalsRequired: jsii.Number(123),
},
},
Approvers: []interface{}{
&ApproverProperty{
PrimaryIdentityId: jsii.String("primaryIdentityId"),
PrimaryIdentitySourceArn: jsii.String("primaryIdentitySourceArn"),
// the properties below are optional
ApproverId: jsii.String("approverId"),
PrimaryIdentityStatus: jsii.String("primaryIdentityStatus"),
ResponseTime: jsii.String("responseTime"),
},
},
Description: jsii.String("description"),
Name: jsii.String("name"),
Policies: []interface{}{
&PolicyProperty{
PolicyArn: jsii.String("policyArn"),
},
},
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html
func NewCfnApprovalTeam ¶
func NewCfnApprovalTeam(scope constructs.Construct, id *string, props *CfnApprovalTeamProps) CfnApprovalTeam
Create a new `AWS::MPA::ApprovalTeam`.
type CfnApprovalTeamProps ¶
type CfnApprovalTeamProps struct {
// Contains details for how an approval team grants approval.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-approvalstrategy
//
ApprovalStrategy interface{} `field:"required" json:"approvalStrategy" yaml:"approvalStrategy"`
// Contains details for an approver.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-approvers
//
Approvers interface{} `field:"required" json:"approvers" yaml:"approvers"`
// Description for the team.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-description
//
Description *string `field:"required" json:"description" yaml:"description"`
// Name of the team.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Contains details for a policy.
//
// Policies define what operations a team that define the permissions for team resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-policies
//
Policies interface{} `field:"required" json:"policies" yaml:"policies"`
// Tags that you have added to the specified resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html#cfn-mpa-approvalteam-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnApprovalTeam`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApprovalTeamProps := &CfnApprovalTeamProps{
ApprovalStrategy: &ApprovalStrategyProperty{
MofN: &MofNApprovalStrategyProperty{
MinApprovalsRequired: jsii.Number(123),
},
},
Approvers: []interface{}{
&ApproverProperty{
PrimaryIdentityId: jsii.String("primaryIdentityId"),
PrimaryIdentitySourceArn: jsii.String("primaryIdentitySourceArn"),
// the properties below are optional
ApproverId: jsii.String("approverId"),
PrimaryIdentityStatus: jsii.String("primaryIdentityStatus"),
ResponseTime: jsii.String("responseTime"),
},
},
Description: jsii.String("description"),
Name: jsii.String("name"),
Policies: []interface{}{
&PolicyProperty{
PolicyArn: jsii.String("policyArn"),
},
},
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-approvalteam.html
type CfnApprovalTeam_ApprovalStrategyProperty ¶
type CfnApprovalTeam_ApprovalStrategyProperty struct {
// Minimum number of approvals (M) required for a total number of approvers (N).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approvalstrategy.html#cfn-mpa-approvalteam-approvalstrategy-mofn
//
MofN interface{} `field:"required" json:"mofN" yaml:"mofN"`
}
Strategy for how an approval team grants approval.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
approvalStrategyProperty := &ApprovalStrategyProperty{
MofN: &MofNApprovalStrategyProperty{
MinApprovalsRequired: jsii.Number(123),
},
}
type CfnApprovalTeam_ApproverProperty ¶
type CfnApprovalTeam_ApproverProperty struct {
// ID for the user.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approver.html#cfn-mpa-approvalteam-approver-primaryidentityid
//
PrimaryIdentityId *string `field:"required" json:"primaryIdentityId" yaml:"primaryIdentityId"`
// Amazon Resource Name (ARN) for the identity source.
//
// The identity source manages the user authentication for approvers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approver.html#cfn-mpa-approvalteam-approver-primaryidentitysourcearn
//
PrimaryIdentitySourceArn *string `field:"required" json:"primaryIdentitySourceArn" yaml:"primaryIdentitySourceArn"`
// ID for the approver.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approver.html#cfn-mpa-approvalteam-approver-approverid
//
ApproverId *string `field:"optional" json:"approverId" yaml:"approverId"`
// Status for the identity source.
//
// For example, if an approver has accepted a team invitation with a user authentication method managed by the identity source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approver.html#cfn-mpa-approvalteam-approver-primaryidentitystatus
//
PrimaryIdentityStatus *string `field:"optional" json:"primaryIdentityStatus" yaml:"primaryIdentityStatus"`
// Timestamp when the approver responded to an approval team invitation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-approver.html#cfn-mpa-approvalteam-approver-responsetime
//
ResponseTime *string `field:"optional" json:"responseTime" yaml:"responseTime"`
}
Contains details for an approver.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
approverProperty := &ApproverProperty{
PrimaryIdentityId: jsii.String("primaryIdentityId"),
PrimaryIdentitySourceArn: jsii.String("primaryIdentitySourceArn"),
// the properties below are optional
ApproverId: jsii.String("approverId"),
PrimaryIdentityStatus: jsii.String("primaryIdentityStatus"),
ResponseTime: jsii.String("responseTime"),
}
type CfnApprovalTeam_MofNApprovalStrategyProperty ¶
type CfnApprovalTeam_MofNApprovalStrategyProperty struct {
// Minimum number of approvals (M) required for a total number of approvers (N).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-mofnapprovalstrategy.html#cfn-mpa-approvalteam-mofnapprovalstrategy-minapprovalsrequired
//
MinApprovalsRequired *float64 `field:"required" json:"minApprovalsRequired" yaml:"minApprovalsRequired"`
}
Strategy for how an approval team grants approval.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
mofNApprovalStrategyProperty := &MofNApprovalStrategyProperty{
MinApprovalsRequired: jsii.Number(123),
}
type CfnApprovalTeam_PolicyProperty ¶
type CfnApprovalTeam_PolicyProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-approvalteam-policy.html#cfn-mpa-approvalteam-policy-policyarn
//
PolicyArn *string `field:"required" json:"policyArn" yaml:"policyArn"`
}
Contains details for a policy.
Policies define what operations a team that define the permissions for team resources.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
policyProperty := &PolicyProperty{
PolicyArn: jsii.String("policyArn"),
}
type CfnIdentitySource ¶
type CfnIdentitySource interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmpa.IIdentitySourceRef
awscdk.ITaggableV2
// Timestamp when the identity source was created.
AttrCreationTime() *string
// Amazon Resource Name (ARN) for the identity source.
AttrIdentitySourceArn() *string
// URL for the approval portal associated with the IAM Identity Center instance.
AttrIdentitySourceParametersIamIdentityCenterApprovalPortalUrl() *string
// The type of resource that provided identities to the identity source.
//
// For example, an IAM Identity Center instance.
AttrIdentitySourceType() *string
// Status for the identity source.
//
// For example, if the identity source is `ACTIVE` .
AttrStatus() *string
// Status code of the identity source.
AttrStatusCode() *string
// Message describing the status for the identity source.
AttrStatusMessage() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// A `IdentitySourceParameters` object.
IdentitySourceParameters() interface{}
SetIdentitySourceParameters(val interface{})
// A reference to a IdentitySource resource.
IdentitySourceRef() *interfacesawsmpa.IdentitySourceReference
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags that you have added to the specified resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a new identity source.
For more information, see [Identity Source](https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html) in the *Multi-party approval User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIdentitySource := awscdk.Aws_mpa.NewCfnIdentitySource(this, jsii.String("MyCfnIdentitySource"), &CfnIdentitySourceProps{
IdentitySourceParameters: &IdentitySourceParametersProperty{
IamIdentityCenter: &IamIdentityCenterProperty{
InstanceArn: jsii.String("instanceArn"),
Region: jsii.String("region"),
// the properties below are optional
ApprovalPortalUrl: jsii.String("approvalPortalUrl"),
},
},
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-identitysource.html
func NewCfnIdentitySource ¶
func NewCfnIdentitySource(scope constructs.Construct, id *string, props *CfnIdentitySourceProps) CfnIdentitySource
Create a new `AWS::MPA::IdentitySource`.
type CfnIdentitySourceProps ¶
type CfnIdentitySourceProps struct {
// A `IdentitySourceParameters` object.
//
// Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-identitysource.html#cfn-mpa-identitysource-identitysourceparameters
//
IdentitySourceParameters interface{} `field:"required" json:"identitySourceParameters" yaml:"identitySourceParameters"`
// Tags that you have added to the specified resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-identitysource.html#cfn-mpa-identitysource-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIdentitySource`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIdentitySourceProps := &CfnIdentitySourceProps{
IdentitySourceParameters: &IdentitySourceParametersProperty{
IamIdentityCenter: &IamIdentityCenterProperty{
InstanceArn: jsii.String("instanceArn"),
Region: jsii.String("region"),
// the properties below are optional
ApprovalPortalUrl: jsii.String("approvalPortalUrl"),
},
},
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mpa-identitysource.html
type CfnIdentitySource_IamIdentityCenterProperty ¶
type CfnIdentitySource_IamIdentityCenterProperty struct {
// Amazon Resource Name (ARN) for the IAM Identity Center instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-identitysource-iamidentitycenter.html#cfn-mpa-identitysource-iamidentitycenter-instancearn
//
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// AWS Region where the IAM Identity Center instance is located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-identitysource-iamidentitycenter.html#cfn-mpa-identitysource-iamidentitycenter-region
//
Region *string `field:"required" json:"region" yaml:"region"`
// URL for the approval portal associated with the IAM Identity Center instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-identitysource-iamidentitycenter.html#cfn-mpa-identitysource-iamidentitycenter-approvalportalurl
//
ApprovalPortalUrl *string `field:"optional" json:"approvalPortalUrl" yaml:"approvalPortalUrl"`
}
AWS IAM Identity Center credentials.
For more information see, [AWS IAM Identity Center](https://docs.aws.amazon.com/identity-center/) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamIdentityCenterProperty := &IamIdentityCenterProperty{
InstanceArn: jsii.String("instanceArn"),
Region: jsii.String("region"),
// the properties below are optional
ApprovalPortalUrl: jsii.String("approvalPortalUrl"),
}
type CfnIdentitySource_IdentitySourceParametersProperty ¶
type CfnIdentitySource_IdentitySourceParametersProperty struct {
// AWS IAM Identity Center credentials.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mpa-identitysource-identitysourceparameters.html#cfn-mpa-identitysource-identitysourceparameters-iamidentitycenter
//
IamIdentityCenter interface{} `field:"required" json:"iamIdentityCenter" yaml:"iamIdentityCenter"`
}
Contains details for the resource that provides identities to the identity source.
For example, an IAM Identity Center instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
identitySourceParametersProperty := &IdentitySourceParametersProperty{
IamIdentityCenter: &IamIdentityCenterProperty{
InstanceArn: jsii.String("instanceArn"),
Region: jsii.String("region"),
// the properties below are optional
ApprovalPortalUrl: jsii.String("approvalPortalUrl"),
},
}
Source Files
¶
- CfnApprovalTeam.go
- CfnApprovalTeamProps.go
- CfnApprovalTeam_ApprovalStrategyProperty.go
- CfnApprovalTeam_ApproverProperty.go
- CfnApprovalTeam_MofNApprovalStrategyProperty.go
- CfnApprovalTeam_PolicyProperty.go
- CfnApprovalTeam__checks.go
- CfnIdentitySource.go
- CfnIdentitySourceProps.go
- CfnIdentitySource_IamIdentityCenterProperty.go
- CfnIdentitySource_IdentitySourceParametersProperty.go
- CfnIdentitySource__checks.go
- main.go