Documentation
¶
Index ¶
- func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProfilePermission_IsCfnElement(x interface{}) *bool
- func CfnProfilePermission_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnProfilePermission_IsConstruct(x interface{}) *bool
- func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSigningProfile_IsCfnElement(x interface{}) *bool
- func CfnSigningProfile_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSigningProfile_IsConstruct(x interface{}) *bool
- func NewCfnProfilePermission_Override(c CfnProfilePermission, scope awscdk.Construct, id *string, ...)
- func NewCfnSigningProfile_Override(c CfnSigningProfile, scope awscdk.Construct, id *string, ...)
- func NewSigningProfile_Override(s SigningProfile, scope constructs.Construct, id *string, ...)
- func SigningProfile_IsConstruct(x interface{}) *bool
- func SigningProfile_IsResource(construct awscdk.IConstruct) *bool
- type CfnProfilePermission
- type CfnProfilePermissionProps
- type CfnSigningProfile
- type CfnSigningProfileProps
- type CfnSigningProfile_SignatureValidityPeriodProperty
- type ISigningProfile
- type Platform
- type SigningProfile
- type SigningProfileAttributes
- type SigningProfileProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME ¶
func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME() *string
func CfnProfilePermission_IsCfnElement ¶
func CfnProfilePermission_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 CfnProfilePermission_IsCfnResource ¶
func CfnProfilePermission_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnProfilePermission_IsConstruct ¶
func CfnProfilePermission_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnSigningProfile_IsCfnElement ¶
func CfnSigningProfile_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 CfnSigningProfile_IsCfnResource ¶
func CfnSigningProfile_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSigningProfile_IsConstruct ¶
func CfnSigningProfile_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnProfilePermission_Override ¶
func NewCfnProfilePermission_Override(c CfnProfilePermission, scope awscdk.Construct, id *string, props *CfnProfilePermissionProps)
Create a new `AWS::Signer::ProfilePermission`.
func NewCfnSigningProfile_Override ¶
func NewCfnSigningProfile_Override(c CfnSigningProfile, scope awscdk.Construct, id *string, props *CfnSigningProfileProps)
Create a new `AWS::Signer::SigningProfile`.
func NewSigningProfile_Override ¶
func NewSigningProfile_Override(s SigningProfile, scope constructs.Construct, id *string, props *SigningProfileProps)
Experimental.
func SigningProfile_IsConstruct ¶
func SigningProfile_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func SigningProfile_IsResource ¶
func SigningProfile_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
Types ¶
type CfnProfilePermission ¶
type CfnProfilePermission interface {
awscdk.CfnResource
awscdk.IInspectable
// The AWS Signer action permitted as part of cross-account permissions.
Action() *string
SetAction(val *string)
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// 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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// The AWS principal receiving cross-account permissions.
//
// This may be an IAM role or another AWS account ID.
Principal() *string
SetPrincipal(val *string)
// The human-readable name of the signing profile.
ProfileName() *string
SetProfileName(val *string)
// The version of the signing profile.
ProfileVersion() *string
SetProfileVersion(val *string)
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// A unique identifier for the cross-account permission statement.
StatementId() *string
SetStatementId(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Signer::ProfilePermission`.
Adds cross-account permissions to a signing profile.
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"
cfnProfilePermission := awscdk.Aws_signer.NewCfnProfilePermission(this, jsii.String("MyCfnProfilePermission"), &cfnProfilePermissionProps{
action: jsii.String("action"),
principal: jsii.String("principal"),
profileName: jsii.String("profileName"),
statementId: jsii.String("statementId"),
// the properties below are optional
profileVersion: jsii.String("profileVersion"),
})
func NewCfnProfilePermission ¶
func NewCfnProfilePermission(scope awscdk.Construct, id *string, props *CfnProfilePermissionProps) CfnProfilePermission
Create a new `AWS::Signer::ProfilePermission`.
type CfnProfilePermissionProps ¶
type CfnProfilePermissionProps struct {
// The AWS Signer action permitted as part of cross-account permissions.
Action *string `field:"required" json:"action" yaml:"action"`
// The AWS principal receiving cross-account permissions.
//
// This may be an IAM role or another AWS account ID.
Principal *string `field:"required" json:"principal" yaml:"principal"`
// The human-readable name of the signing profile.
ProfileName *string `field:"required" json:"profileName" yaml:"profileName"`
// A unique identifier for the cross-account permission statement.
StatementId *string `field:"required" json:"statementId" yaml:"statementId"`
// The version of the signing profile.
ProfileVersion *string `field:"optional" json:"profileVersion" yaml:"profileVersion"`
}
Properties for defining a `CfnProfilePermission`.
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"
cfnProfilePermissionProps := &cfnProfilePermissionProps{
action: jsii.String("action"),
principal: jsii.String("principal"),
profileName: jsii.String("profileName"),
statementId: jsii.String("statementId"),
// the properties below are optional
profileVersion: jsii.String("profileVersion"),
}
type CfnSigningProfile ¶
type CfnSigningProfile interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrProfileName() *string
AttrProfileVersion() *string
AttrProfileVersionArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// 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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// The ID of a platform that is available for use by a signing profile.
PlatformId() *string
SetPlatformId(val *string)
// 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 })`.
// Experimental.
Ref() *string
// The validity period override for any signature generated using this signing profile.
//
// If unspecified, the default is 135 months.
SignatureValidityPeriod() interface{}
SetSignatureValidityPeriod(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// A list of tags associated with the signing profile.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Signer::SigningProfile`.
Creates a signing profile. A signing profile is a code signing template that can be used to carry out a pre-defined signing job.
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"
cfnSigningProfile := awscdk.Aws_signer.NewCfnSigningProfile(this, jsii.String("MyCfnSigningProfile"), &cfnSigningProfileProps{
platformId: jsii.String("platformId"),
// the properties below are optional
signatureValidityPeriod: &signatureValidityPeriodProperty{
type: jsii.String("type"),
value: jsii.Number(123),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnSigningProfile ¶
func NewCfnSigningProfile(scope awscdk.Construct, id *string, props *CfnSigningProfileProps) CfnSigningProfile
Create a new `AWS::Signer::SigningProfile`.
type CfnSigningProfileProps ¶
type CfnSigningProfileProps struct {
// The ID of a platform that is available for use by a signing profile.
PlatformId *string `field:"required" json:"platformId" yaml:"platformId"`
// The validity period override for any signature generated using this signing profile.
//
// If unspecified, the default is 135 months.
SignatureValidityPeriod interface{} `field:"optional" json:"signatureValidityPeriod" yaml:"signatureValidityPeriod"`
// A list of tags associated with the signing profile.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSigningProfile`.
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"
cfnSigningProfileProps := &cfnSigningProfileProps{
platformId: jsii.String("platformId"),
// the properties below are optional
signatureValidityPeriod: &signatureValidityPeriodProperty{
type: jsii.String("type"),
value: jsii.Number(123),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnSigningProfile_SignatureValidityPeriodProperty ¶
type CfnSigningProfile_SignatureValidityPeriodProperty struct {
// The time unit for signature validity: DAYS | MONTHS | YEARS.
Type *string `field:"optional" json:"type" yaml:"type"`
// The numerical value of the time unit for signature validity.
Value *float64 `field:"optional" json:"value" yaml:"value"`
}
The validity period for the signing job.
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"
signatureValidityPeriodProperty := &signatureValidityPeriodProperty{
type: jsii.String("type"),
value: jsii.Number(123),
}
type ISigningProfile ¶
type ISigningProfile interface {
awscdk.IResource
// The ARN of the signing profile.
// Experimental.
SigningProfileArn() *string
// The name of signing profile.
// Experimental.
SigningProfileName() *string
// The version of signing profile.
// Experimental.
SigningProfileVersion() *string
// The ARN of signing profile version.
// Experimental.
SigningProfileVersionArn() *string
}
A Signer Profile. Experimental.
func SigningProfile_FromSigningProfileAttributes ¶
func SigningProfile_FromSigningProfileAttributes(scope constructs.Construct, id *string, attrs *SigningProfileAttributes) ISigningProfile
Creates a Signing Profile construct that represents an external Signing Profile. Experimental.
type Platform ¶
type Platform interface {
// The id of signing platform.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-platformid
//
// Experimental.
PlatformId() *string
}
Platforms that are allowed with signing config.
Example:
import signer "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &signingProfileProps{
platform: signer.platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &codeSigningConfigProps{
signingProfiles: []iSigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &functionProps{
codeSigningConfig: codeSigningConfig,
runtime: lambda.runtime_NODEJS_16_X(),
handler: jsii.String("index.handler"),
code: lambda.code.fromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
See: https://docs.aws.amazon.com/signer/latest/developerguide/gs-platform.html
Experimental.
func Platform_AMAZON_FREE_RTOS_DEFAULT ¶
func Platform_AMAZON_FREE_RTOS_DEFAULT() Platform
func Platform_AMAZON_FREE_RTOS_TI_CC3220SF ¶
func Platform_AMAZON_FREE_RTOS_TI_CC3220SF() Platform
func Platform_AWS_IOT_DEVICE_MANAGEMENT_SHA256_ECDSA ¶
func Platform_AWS_IOT_DEVICE_MANAGEMENT_SHA256_ECDSA() Platform
func Platform_AWS_LAMBDA_SHA384_ECDSA ¶
func Platform_AWS_LAMBDA_SHA384_ECDSA() Platform
type SigningProfile ¶
type SigningProfile interface {
awscdk.Resource
ISigningProfile
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
// Experimental.
Env() *awscdk.ResourceEnvironment
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
// The ARN of the signing profile.
// Experimental.
SigningProfileArn() *string
// The name of signing profile.
// Experimental.
SigningProfileName() *string
// The version of signing profile.
// Experimental.
SigningProfileVersion() *string
// The ARN of signing profile version.
// Experimental.
SigningProfileVersionArn() *string
// The stack in which this resource is defined.
// Experimental.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// 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`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Experimental.
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
// Experimental.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
// Experimental.
GetResourceNameAttribute(nameAttr *string) *string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
}
Defines a Signing Profile.
Example:
import signer "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &signingProfileProps{
platform: signer.platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &codeSigningConfigProps{
signingProfiles: []iSigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &functionProps{
codeSigningConfig: codeSigningConfig,
runtime: lambda.runtime_NODEJS_16_X(),
handler: jsii.String("index.handler"),
code: lambda.code.fromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
Experimental.
func NewSigningProfile ¶
func NewSigningProfile(scope constructs.Construct, id *string, props *SigningProfileProps) SigningProfile
Experimental.
type SigningProfileAttributes ¶
type SigningProfileAttributes struct {
// The name of signing profile.
// Experimental.
SigningProfileName *string `field:"required" json:"signingProfileName" yaml:"signingProfileName"`
// The version of signing profile.
// Experimental.
SigningProfileVersion *string `field:"required" json:"signingProfileVersion" yaml:"signingProfileVersion"`
}
A reference to a Signing Profile.
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"
signingProfileAttributes := &signingProfileAttributes{
signingProfileName: jsii.String("signingProfileName"),
signingProfileVersion: jsii.String("signingProfileVersion"),
}
Experimental.
type SigningProfileProps ¶
type SigningProfileProps struct {
// The Signing Platform available for signing profile.
// See: https://docs.aws.amazon.com/signer/latest/developerguide/gs-platform.html
//
// Experimental.
Platform Platform `field:"required" json:"platform" yaml:"platform"`
// The validity period for signatures generated using this signing profile.
// Experimental.
SignatureValidity awscdk.Duration `field:"optional" json:"signatureValidity" yaml:"signatureValidity"`
// Physical name of this Signing Profile.
// Experimental.
SigningProfileName *string `field:"optional" json:"signingProfileName" yaml:"signingProfileName"`
}
Construction properties for a Signing Profile object.
Example:
import signer "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &signingProfileProps{
platform: signer.platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &codeSigningConfigProps{
signingProfiles: []iSigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &functionProps{
codeSigningConfig: codeSigningConfig,
runtime: lambda.runtime_NODEJS_16_X(),
handler: jsii.String("index.handler"),
code: lambda.code.fromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
Experimental.