Documentation
¶
Index ¶
- func CfnAgentSpace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAgentSpace_IsCfnAgentSpace(x interface{}) *bool
- func CfnAgentSpace_IsCfnElement(x interface{}) *bool
- func CfnAgentSpace_IsCfnResource(x interface{}) *bool
- func CfnAgentSpace_IsConstruct(x interface{}) *bool
- func CfnApplication_ArnForApplication(resource interfacesawssecurityagent.IApplicationRef) *string
- func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApplication_FromApplicationId(scope constructs.Construct, id *string, applicationId *string) interfacesawssecurityagent.IApplicationRef
- func CfnApplication_IsCfnApplication(x interface{}) *bool
- func CfnApplication_IsCfnElement(x interface{}) *bool
- func CfnApplication_IsCfnResource(x interface{}) *bool
- func CfnApplication_IsConstruct(x interface{}) *bool
- func CfnPentest_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPentest_IsCfnElement(x interface{}) *bool
- func CfnPentest_IsCfnPentest(x interface{}) *bool
- func CfnPentest_IsCfnResource(x interface{}) *bool
- func CfnPentest_IsConstruct(x interface{}) *bool
- func CfnTargetDomain_ArnForTargetDomain(resource interfacesawssecurityagent.ITargetDomainRef) *string
- func CfnTargetDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTargetDomain_FromTargetDomainId(scope constructs.Construct, id *string, targetDomainId *string) interfacesawssecurityagent.ITargetDomainRef
- func CfnTargetDomain_IsCfnElement(x interface{}) *bool
- func CfnTargetDomain_IsCfnResource(x interface{}) *bool
- func CfnTargetDomain_IsCfnTargetDomain(x interface{}) *bool
- func CfnTargetDomain_IsConstruct(x interface{}) *bool
- func NewCfnAgentSpace_Override(c CfnAgentSpace, scope constructs.Construct, id *string, ...)
- func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, ...)
- func NewCfnPentest_Override(c CfnPentest, scope constructs.Construct, id *string, props *CfnPentestProps)
- func NewCfnTargetDomain_Override(c CfnTargetDomain, scope constructs.Construct, id *string, ...)
- type CfnAgentSpace
- type CfnAgentSpaceProps
- type CfnAgentSpace_AWSResourcesProperty
- type CfnAgentSpace_CodeReviewSettingsProperty
- type CfnAgentSpace_IntegratedResourceProperty
- type CfnAgentSpace_VpcConfigProperty
- type CfnApplication
- type CfnApplicationProps
- type CfnApplication_IdCConfigurationProperty
- type CfnPentest
- type CfnPentestProps
- type CfnPentest_ActorProperty
- type CfnPentest_AssetsProperty
- type CfnPentest_AuthenticationProperty
- type CfnPentest_CloudWatchLogProperty
- type CfnPentest_CustomHeaderProperty
- type CfnPentest_DocumentInfoProperty
- type CfnPentest_EndpointProperty
- type CfnPentest_IntegratedRepositoryProperty
- type CfnPentest_NetworkTrafficConfigProperty
- type CfnPentest_NetworkTrafficRuleProperty
- type CfnPentest_SourceCodeRepositoryProperty
- type CfnPentest_VpcConfigProperty
- type CfnTargetDomain
- type CfnTargetDomainProps
- type CfnTargetDomain_DnsVerificationProperty
- type CfnTargetDomain_HttpVerificationProperty
- type CfnTargetDomain_VerificationDetailsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAgentSpace_CFN_RESOURCE_TYPE_NAME ¶
func CfnAgentSpace_CFN_RESOURCE_TYPE_NAME() *string
func CfnAgentSpace_IsCfnAgentSpace ¶
func CfnAgentSpace_IsCfnAgentSpace(x interface{}) *bool
Checks whether the given object is a CfnAgentSpace.
func CfnAgentSpace_IsCfnElement ¶
func CfnAgentSpace_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 CfnAgentSpace_IsCfnResource ¶
func CfnAgentSpace_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAgentSpace_IsConstruct ¶
func CfnAgentSpace_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 CfnApplication_ArnForApplication ¶
func CfnApplication_ArnForApplication(resource interfacesawssecurityagent.IApplicationRef) *string
func CfnApplication_CFN_RESOURCE_TYPE_NAME ¶
func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
func CfnApplication_FromApplicationId ¶
func CfnApplication_FromApplicationId(scope constructs.Construct, id *string, applicationId *string) interfacesawssecurityagent.IApplicationRef
Creates a new IApplicationRef from a applicationId.
func CfnApplication_IsCfnApplication ¶
func CfnApplication_IsCfnApplication(x interface{}) *bool
Checks whether the given object is a CfnApplication.
func CfnApplication_IsCfnElement ¶
func CfnApplication_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 CfnApplication_IsCfnResource ¶
func CfnApplication_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApplication_IsConstruct ¶
func CfnApplication_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 CfnPentest_CFN_RESOURCE_TYPE_NAME ¶
func CfnPentest_CFN_RESOURCE_TYPE_NAME() *string
func CfnPentest_IsCfnElement ¶
func CfnPentest_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 CfnPentest_IsCfnPentest ¶
func CfnPentest_IsCfnPentest(x interface{}) *bool
Checks whether the given object is a CfnPentest.
func CfnPentest_IsCfnResource ¶
func CfnPentest_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPentest_IsConstruct ¶
func CfnPentest_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 CfnTargetDomain_ArnForTargetDomain ¶
func CfnTargetDomain_ArnForTargetDomain(resource interfacesawssecurityagent.ITargetDomainRef) *string
func CfnTargetDomain_CFN_RESOURCE_TYPE_NAME ¶
func CfnTargetDomain_CFN_RESOURCE_TYPE_NAME() *string
func CfnTargetDomain_FromTargetDomainId ¶
func CfnTargetDomain_FromTargetDomainId(scope constructs.Construct, id *string, targetDomainId *string) interfacesawssecurityagent.ITargetDomainRef
Creates a new ITargetDomainRef from a targetDomainId.
func CfnTargetDomain_IsCfnElement ¶
func CfnTargetDomain_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 CfnTargetDomain_IsCfnResource ¶
func CfnTargetDomain_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTargetDomain_IsCfnTargetDomain ¶
func CfnTargetDomain_IsCfnTargetDomain(x interface{}) *bool
Checks whether the given object is a CfnTargetDomain.
func CfnTargetDomain_IsConstruct ¶
func CfnTargetDomain_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 NewCfnAgentSpace_Override ¶
func NewCfnAgentSpace_Override(c CfnAgentSpace, scope constructs.Construct, id *string, props *CfnAgentSpaceProps)
Create a new `AWS::SecurityAgent::AgentSpace`.
func NewCfnApplication_Override ¶
func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, props *CfnApplicationProps)
Create a new `AWS::SecurityAgent::Application`.
func NewCfnPentest_Override ¶
func NewCfnPentest_Override(c CfnPentest, scope constructs.Construct, id *string, props *CfnPentestProps)
Create a new `AWS::SecurityAgent::Pentest`.
func NewCfnTargetDomain_Override ¶
func NewCfnTargetDomain_Override(c CfnTargetDomain, scope constructs.Construct, id *string, props *CfnTargetDomainProps)
Create a new `AWS::SecurityAgent::TargetDomain`.
Types ¶
type CfnAgentSpace ¶
type CfnAgentSpace interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssecurityagent.IAgentSpaceRef
awscdk.ITaggableV2
// A reference to a AgentSpace resource.
AgentSpaceRef() *interfacesawssecurityagent.AgentSpaceReference
// Unique identifier of the agent space.
AttrAgentSpaceId() *string
// Timestamp when the agent space was created.
AttrCreatedAt() *string
// Timestamp when the agent space was last updated.
AttrUpdatedAt() *string
// AWS resource configuration.
AwsResources() interface{}
SetAwsResources(val interface{})
// 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{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Details of code review settings.
CodeReviewSettings() interface{}
SetCodeReviewSettings(val interface{})
// 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 of the agent space.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// Integrated Resources configuration.
IntegratedResources() interface{}
SetIntegratedResources(val interface{})
// Identifier of the KMS key used to encrypt data.
KmsKeyId() *string
SetKmsKeyId(val *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.
LogicalId() *string
// Name of the agent space.
Name() *string
SetName(val *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 for the agent space.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// List of target domain identifiers registered with the agent space.
TargetDomainIds() *[]*string
SetTargetDomainIds(val *[]*string)
// 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 cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::SecurityAgent::AgentSpace.
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"
cfnAgentSpace := awscdk.Aws_securityagent.NewCfnAgentSpace(this, jsii.String("MyCfnAgentSpace"), &CfnAgentSpaceProps{
Name: jsii.String("name"),
// the properties below are optional
AwsResources: &AWSResourcesProperty{
IamRoles: []*string{
jsii.String("iamRoles"),
},
LambdaFunctionArns: []*string{
jsii.String("lambdaFunctionArns"),
},
LogGroups: []*string{
jsii.String("logGroups"),
},
S3Buckets: []*string{
jsii.String("s3Buckets"),
},
SecretArns: []*string{
jsii.String("secretArns"),
},
Vpcs: []interface{}{
&VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
},
},
},
CodeReviewSettings: &CodeReviewSettingsProperty{
ControlsScanning: jsii.Boolean(false),
GeneralPurposeScanning: jsii.Boolean(false),
},
Description: jsii.String("description"),
IntegratedResources: []interface{}{
&IntegratedResourceProperty{
Integration: jsii.String("integration"),
},
},
KmsKeyId: jsii.String("kmsKeyId"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TargetDomainIds: []*string{
jsii.String("targetDomainIds"),
},
})
func NewCfnAgentSpace ¶
func NewCfnAgentSpace(scope constructs.Construct, id *string, props *CfnAgentSpaceProps) CfnAgentSpace
Create a new `AWS::SecurityAgent::AgentSpace`.
type CfnAgentSpaceProps ¶
type CfnAgentSpaceProps struct {
// Name of the agent space.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// AWS resource configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-awsresources
//
AwsResources interface{} `field:"optional" json:"awsResources" yaml:"awsResources"`
// Details of code review settings.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-codereviewsettings
//
CodeReviewSettings interface{} `field:"optional" json:"codeReviewSettings" yaml:"codeReviewSettings"`
// Description of the agent space.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Integrated Resources configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-integratedresources
//
IntegratedResources interface{} `field:"optional" json:"integratedResources" yaml:"integratedResources"`
// Identifier of the KMS key used to encrypt data.
//
// Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// Tags for the agent space.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// List of target domain identifiers registered with the agent space.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-agentspace.html#cfn-securityagent-agentspace-targetdomainids
//
TargetDomainIds *[]*string `field:"optional" json:"targetDomainIds" yaml:"targetDomainIds"`
}
Properties for defining a `CfnAgentSpace`.
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"
cfnAgentSpaceProps := &CfnAgentSpaceProps{
Name: jsii.String("name"),
// the properties below are optional
AwsResources: &AWSResourcesProperty{
IamRoles: []*string{
jsii.String("iamRoles"),
},
LambdaFunctionArns: []*string{
jsii.String("lambdaFunctionArns"),
},
LogGroups: []*string{
jsii.String("logGroups"),
},
S3Buckets: []*string{
jsii.String("s3Buckets"),
},
SecretArns: []*string{
jsii.String("secretArns"),
},
Vpcs: []interface{}{
&VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
},
},
},
CodeReviewSettings: &CodeReviewSettingsProperty{
ControlsScanning: jsii.Boolean(false),
GeneralPurposeScanning: jsii.Boolean(false),
},
Description: jsii.String("description"),
IntegratedResources: []interface{}{
&IntegratedResourceProperty{
Integration: jsii.String("integration"),
},
},
KmsKeyId: jsii.String("kmsKeyId"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TargetDomainIds: []*string{
jsii.String("targetDomainIds"),
},
}
type CfnAgentSpace_AWSResourcesProperty ¶
type CfnAgentSpace_AWSResourcesProperty struct {
// IAM role ARNs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-iamroles
//
IamRoles *[]*string `field:"optional" json:"iamRoles" yaml:"iamRoles"`
// Lambda function ARNs used to retrieve tester credentials for pentests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-lambdafunctionarns
//
LambdaFunctionArns *[]*string `field:"optional" json:"lambdaFunctionArns" yaml:"lambdaFunctionArns"`
// CloudWatch log group ARNs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-loggroups
//
LogGroups *[]*string `field:"optional" json:"logGroups" yaml:"logGroups"`
// S3 bucket ARNs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-s3buckets
//
S3Buckets *[]*string `field:"optional" json:"s3Buckets" yaml:"s3Buckets"`
// SecretsManager secret ARNs used to store tester credentials for pentests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-secretarns
//
SecretArns *[]*string `field:"optional" json:"secretArns" yaml:"secretArns"`
// VPC configurations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-awsresources.html#cfn-securityagent-agentspace-awsresources-vpcs
//
Vpcs interface{} `field:"optional" json:"vpcs" yaml:"vpcs"`
}
AWS resource configuration.
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"
aWSResourcesProperty := &AWSResourcesProperty{
IamRoles: []*string{
jsii.String("iamRoles"),
},
LambdaFunctionArns: []*string{
jsii.String("lambdaFunctionArns"),
},
LogGroups: []*string{
jsii.String("logGroups"),
},
S3Buckets: []*string{
jsii.String("s3Buckets"),
},
SecretArns: []*string{
jsii.String("secretArns"),
},
Vpcs: []interface{}{
&VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
},
},
}
type CfnAgentSpace_CodeReviewSettingsProperty ¶
type CfnAgentSpace_CodeReviewSettingsProperty struct {
// Whether Controls are utilized for code review analysis.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-codereviewsettings.html#cfn-securityagent-agentspace-codereviewsettings-controlsscanning
//
ControlsScanning interface{} `field:"required" json:"controlsScanning" yaml:"controlsScanning"`
// Whether general purpose analysis is performed for code review.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-codereviewsettings.html#cfn-securityagent-agentspace-codereviewsettings-generalpurposescanning
//
GeneralPurposeScanning interface{} `field:"required" json:"generalPurposeScanning" yaml:"generalPurposeScanning"`
}
Details of code review settings.
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"
codeReviewSettingsProperty := &CodeReviewSettingsProperty{
ControlsScanning: jsii.Boolean(false),
GeneralPurposeScanning: jsii.Boolean(false),
}
type CfnAgentSpace_IntegratedResourceProperty ¶
type CfnAgentSpace_IntegratedResourceProperty struct {
// Unique identifier of the Provider Integration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-integratedresource.html#cfn-securityagent-agentspace-integratedresource-integration
//
Integration *string `field:"required" json:"integration" yaml:"integration"`
}
Integrated Resource details.
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"
integratedResourceProperty := &IntegratedResourceProperty{
Integration: jsii.String("integration"),
}
type CfnAgentSpace_VpcConfigProperty ¶
type CfnAgentSpace_VpcConfigProperty struct {
// List of security group ARNs in the customer VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-vpcconfig.html#cfn-securityagent-agentspace-vpcconfig-securitygrouparns
//
SecurityGroupArns *[]*string `field:"optional" json:"securityGroupArns" yaml:"securityGroupArns"`
// List of subnet ARNs in the customer VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-vpcconfig.html#cfn-securityagent-agentspace-vpcconfig-subnetarns
//
SubnetArns *[]*string `field:"optional" json:"subnetArns" yaml:"subnetArns"`
// ARN of the customer VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-agentspace-vpcconfig.html#cfn-securityagent-agentspace-vpcconfig-vpcarn
//
VpcArn *string `field:"optional" json:"vpcArn" yaml:"vpcArn"`
}
Customer VPC configuration that the security testing environment accesses.
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"
vpcConfigProperty := &VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
}
type CfnApplication ¶
type CfnApplication interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssecurityagent.IApplicationRef
awscdk.ITaggableV2
// A reference to a Application resource.
ApplicationRef() *interfacesawssecurityagent.ApplicationReference
AttrApplicationId() *string
AttrApplicationName() *string
AttrDomain() *string
AttrIdCConfigurationIdCApplicationArn() *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{}
CfnPropertyNames() *map[string]*string
// 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
// Identifier of a KMS key.
DefaultKmsKeyId() *string
SetDefaultKmsKeyId(val *string)
Env() *interfaces.ResourceEnvironment
IdCConfiguration() interface{}
SetIdCConfiguration(val interface{})
// 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
RoleArn() *string
SetRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags for the application.
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 cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::SecurityAgent::Application.
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"
cfnApplication := awscdk.Aws_securityagent.NewCfnApplication(this, jsii.String("MyCfnApplication"), &CfnApplicationProps{
DefaultKmsKeyId: jsii.String("defaultKmsKeyId"),
IdCConfiguration: &IdCConfigurationProperty{
IdCApplicationArn: jsii.String("idCApplicationArn"),
IdCInstanceArn: jsii.String("idCInstanceArn"),
},
RoleArn: jsii.String("roleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnApplication ¶
func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication
Create a new `AWS::SecurityAgent::Application`.
type CfnApplicationProps ¶
type CfnApplicationProps struct {
// Identifier of a KMS key.
//
// Can be a key ID, key ARN, alias name, or alias ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-application.html#cfn-securityagent-application-defaultkmskeyid
//
DefaultKmsKeyId *string `field:"optional" json:"defaultKmsKeyId" yaml:"defaultKmsKeyId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-application.html#cfn-securityagent-application-idcconfiguration
//
IdCConfiguration interface{} `field:"optional" json:"idCConfiguration" yaml:"idCConfiguration"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-application.html#cfn-securityagent-application-rolearn
//
RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
// Tags for the application.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-application.html#cfn-securityagent-application-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnApplication`.
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"
cfnApplicationProps := &CfnApplicationProps{
DefaultKmsKeyId: jsii.String("defaultKmsKeyId"),
IdCConfiguration: &IdCConfigurationProperty{
IdCApplicationArn: jsii.String("idCApplicationArn"),
IdCInstanceArn: jsii.String("idCInstanceArn"),
},
RoleArn: jsii.String("roleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnApplication_IdCConfigurationProperty ¶
type CfnApplication_IdCConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-application-idcconfiguration.html#cfn-securityagent-application-idcconfiguration-idcapplicationarn
//
IdCApplicationArn *string `field:"optional" json:"idCApplicationArn" yaml:"idCApplicationArn"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-application-idcconfiguration.html#cfn-securityagent-application-idcconfiguration-idcinstancearn
//
IdCInstanceArn *string `field:"optional" json:"idCInstanceArn" yaml:"idCInstanceArn"`
}
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"
idCConfigurationProperty := &IdCConfigurationProperty{
IdCApplicationArn: jsii.String("idCApplicationArn"),
IdCInstanceArn: jsii.String("idCInstanceArn"),
}
type CfnPentest ¶
type CfnPentest interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssecurityagent.IPentestRef
// Identifier of agent space where the pentest should be created.
AgentSpaceId() *string
SetAgentSpaceId(val *string)
// Collection of assets to be tested during the pentest.
Assets() interface{}
SetAssets(val interface{})
// Timestamp when the pentest was created.
AttrCreatedAt() *string
// Unique identifier of the pentest.
AttrPentestId() *string
// Timestamp when the pentest was last updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Strategy for remediating code vulnerabilities discovered during the pentest.
CodeRemediationStrategy() *string
SetCodeRemediationStrategy(val *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 list of risk types excluded from the pentest execution.
ExcludeRiskTypes() *[]*string
SetExcludeRiskTypes(val *[]*string)
// CloudWatch Logs configuration for pentest output.
LogConfig() interface{}
SetLogConfig(val interface{})
// 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
// Network traffic configuration for the pentest.
NetworkTrafficConfig() interface{}
SetNetworkTrafficConfig(val interface{})
// The tree node.
Node() constructs.Node
// A reference to a Pentest resource.
PentestRef() *interfacesawssecurityagent.PentestReference
// 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
// Service role for accessing resources.
ServiceRole() *string
SetServiceRole(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Title of the penetration test.
Title() *string
SetTitle(val *string)
// 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{}
// VPC configuration that the pentest agent accesses.
VpcConfig() interface{}
SetVpcConfig(val 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 cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::SecurityAgent::Pentest.
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"
cfnPentest := awscdk.Aws_securityagent.NewCfnPentest(this, jsii.String("MyCfnPentest"), &CfnPentestProps{
AgentSpaceId: jsii.String("agentSpaceId"),
Assets: &AssetsProperty{
Actors: []interface{}{
&ActorProperty{
Authentication: &AuthenticationProperty{
ProviderType: jsii.String("providerType"),
Value: jsii.String("value"),
},
Description: jsii.String("description"),
Identifier: jsii.String("identifier"),
Uris: []*string{
jsii.String("uris"),
},
},
},
Documents: []interface{}{
&DocumentInfoProperty{
ArtifactId: jsii.String("artifactId"),
S3Location: jsii.String("s3Location"),
},
},
Endpoints: []interface{}{
&EndpointProperty{
Uri: jsii.String("uri"),
},
},
IntegratedRepositories: []interface{}{
&IntegratedRepositoryProperty{
IntegrationId: jsii.String("integrationId"),
ProviderResourceId: jsii.String("providerResourceId"),
},
},
SourceCode: []interface{}{
&SourceCodeRepositoryProperty{
S3Location: jsii.String("s3Location"),
},
},
},
ServiceRole: jsii.String("serviceRole"),
// the properties below are optional
CodeRemediationStrategy: jsii.String("codeRemediationStrategy"),
ExcludeRiskTypes: []*string{
jsii.String("excludeRiskTypes"),
},
LogConfig: &CloudWatchLogProperty{
LogGroup: jsii.String("logGroup"),
LogStream: jsii.String("logStream"),
},
NetworkTrafficConfig: &NetworkTrafficConfigProperty{
CustomHeaders: []interface{}{
&CustomHeaderProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
Rules: []interface{}{
&NetworkTrafficRuleProperty{
Effect: jsii.String("effect"),
NetworkTrafficRuleType: jsii.String("networkTrafficRuleType"),
Pattern: jsii.String("pattern"),
},
},
},
Title: jsii.String("title"),
VpcConfig: &VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
},
})
func NewCfnPentest ¶
func NewCfnPentest(scope constructs.Construct, id *string, props *CfnPentestProps) CfnPentest
Create a new `AWS::SecurityAgent::Pentest`.
type CfnPentestProps ¶
type CfnPentestProps struct {
// Identifier of agent space where the pentest should be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-agentspaceid
//
AgentSpaceId *string `field:"required" json:"agentSpaceId" yaml:"agentSpaceId"`
// Collection of assets to be tested during the pentest.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-assets
//
Assets interface{} `field:"required" json:"assets" yaml:"assets"`
// Service role for accessing resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-servicerole
//
ServiceRole *string `field:"required" json:"serviceRole" yaml:"serviceRole"`
// Strategy for remediating code vulnerabilities discovered during the pentest.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-coderemediationstrategy
//
CodeRemediationStrategy *string `field:"optional" json:"codeRemediationStrategy" yaml:"codeRemediationStrategy"`
// A list of risk types excluded from the pentest execution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-excluderisktypes
//
ExcludeRiskTypes *[]*string `field:"optional" json:"excludeRiskTypes" yaml:"excludeRiskTypes"`
// CloudWatch Logs configuration for pentest output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-logconfig
//
LogConfig interface{} `field:"optional" json:"logConfig" yaml:"logConfig"`
// Network traffic configuration for the pentest.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-networktrafficconfig
//
NetworkTrafficConfig interface{} `field:"optional" json:"networkTrafficConfig" yaml:"networkTrafficConfig"`
// Title of the penetration test.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-title
//
Title *string `field:"optional" json:"title" yaml:"title"`
// VPC configuration that the pentest agent accesses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-vpcconfig
//
VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"`
}
Properties for defining a `CfnPentest`.
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"
cfnPentestProps := &CfnPentestProps{
AgentSpaceId: jsii.String("agentSpaceId"),
Assets: &AssetsProperty{
Actors: []interface{}{
&ActorProperty{
Authentication: &AuthenticationProperty{
ProviderType: jsii.String("providerType"),
Value: jsii.String("value"),
},
Description: jsii.String("description"),
Identifier: jsii.String("identifier"),
Uris: []*string{
jsii.String("uris"),
},
},
},
Documents: []interface{}{
&DocumentInfoProperty{
ArtifactId: jsii.String("artifactId"),
S3Location: jsii.String("s3Location"),
},
},
Endpoints: []interface{}{
&EndpointProperty{
Uri: jsii.String("uri"),
},
},
IntegratedRepositories: []interface{}{
&IntegratedRepositoryProperty{
IntegrationId: jsii.String("integrationId"),
ProviderResourceId: jsii.String("providerResourceId"),
},
},
SourceCode: []interface{}{
&SourceCodeRepositoryProperty{
S3Location: jsii.String("s3Location"),
},
},
},
ServiceRole: jsii.String("serviceRole"),
// the properties below are optional
CodeRemediationStrategy: jsii.String("codeRemediationStrategy"),
ExcludeRiskTypes: []*string{
jsii.String("excludeRiskTypes"),
},
LogConfig: &CloudWatchLogProperty{
LogGroup: jsii.String("logGroup"),
LogStream: jsii.String("logStream"),
},
NetworkTrafficConfig: &NetworkTrafficConfigProperty{
CustomHeaders: []interface{}{
&CustomHeaderProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
Rules: []interface{}{
&NetworkTrafficRuleProperty{
Effect: jsii.String("effect"),
NetworkTrafficRuleType: jsii.String("networkTrafficRuleType"),
Pattern: jsii.String("pattern"),
},
},
},
Title: jsii.String("title"),
VpcConfig: &VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
},
}
type CfnPentest_ActorProperty ¶
type CfnPentest_ActorProperty struct {
// Authentication configuration for a pentest actor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-authentication
//
Authentication interface{} `field:"optional" json:"authentication" yaml:"authentication"`
// Description of the actor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Identifier for the actor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-identifier
//
Identifier *string `field:"optional" json:"identifier" yaml:"identifier"`
// List of URIs this actor is authorized to access.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-uris
//
Uris *[]*string `field:"optional" json:"uris" yaml:"uris"`
}
An authenticated actor to be used during pentest execution.
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"
actorProperty := &ActorProperty{
Authentication: &AuthenticationProperty{
ProviderType: jsii.String("providerType"),
Value: jsii.String("value"),
},
Description: jsii.String("description"),
Identifier: jsii.String("identifier"),
Uris: []*string{
jsii.String("uris"),
},
}
type CfnPentest_AssetsProperty ¶
type CfnPentest_AssetsProperty struct {
// List of actors used during testing.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-actors
//
Actors interface{} `field:"optional" json:"actors" yaml:"actors"`
// List of documents providing additional context for the pentest.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-documents
//
Documents interface{} `field:"optional" json:"documents" yaml:"documents"`
// List of endpoints to test.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-endpoints
//
Endpoints interface{} `field:"optional" json:"endpoints" yaml:"endpoints"`
// List of repositories connected via provider integrations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-integratedrepositories
//
IntegratedRepositories interface{} `field:"optional" json:"integratedRepositories" yaml:"integratedRepositories"`
// List of source code repositories to analyze.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-sourcecode
//
SourceCode interface{} `field:"optional" json:"sourceCode" yaml:"sourceCode"`
}
Collection of assets to be tested during the pentest.
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"
assetsProperty := &AssetsProperty{
Actors: []interface{}{
&ActorProperty{
Authentication: &AuthenticationProperty{
ProviderType: jsii.String("providerType"),
Value: jsii.String("value"),
},
Description: jsii.String("description"),
Identifier: jsii.String("identifier"),
Uris: []*string{
jsii.String("uris"),
},
},
},
Documents: []interface{}{
&DocumentInfoProperty{
ArtifactId: jsii.String("artifactId"),
S3Location: jsii.String("s3Location"),
},
},
Endpoints: []interface{}{
&EndpointProperty{
Uri: jsii.String("uri"),
},
},
IntegratedRepositories: []interface{}{
&IntegratedRepositoryProperty{
IntegrationId: jsii.String("integrationId"),
ProviderResourceId: jsii.String("providerResourceId"),
},
},
SourceCode: []interface{}{
&SourceCodeRepositoryProperty{
S3Location: jsii.String("s3Location"),
},
},
}
type CfnPentest_AuthenticationProperty ¶
type CfnPentest_AuthenticationProperty struct {
// Type of authentication provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-authentication.html#cfn-securityagent-pentest-authentication-providertype
//
ProviderType *string `field:"optional" json:"providerType" yaml:"providerType"`
// Reference value for the authentication provider, such as a secret ARN or Lambda ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-authentication.html#cfn-securityagent-pentest-authentication-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
Authentication configuration for a pentest actor.
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"
authenticationProperty := &AuthenticationProperty{
ProviderType: jsii.String("providerType"),
Value: jsii.String("value"),
}
type CfnPentest_CloudWatchLogProperty ¶
type CfnPentest_CloudWatchLogProperty struct {
// CloudWatch log group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-cloudwatchlog.html#cfn-securityagent-pentest-cloudwatchlog-loggroup
//
LogGroup *string `field:"optional" json:"logGroup" yaml:"logGroup"`
// CloudWatch log stream.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-cloudwatchlog.html#cfn-securityagent-pentest-cloudwatchlog-logstream
//
LogStream *string `field:"optional" json:"logStream" yaml:"logStream"`
}
CloudWatch Logs configuration for pentest output.
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"
cloudWatchLogProperty := &CloudWatchLogProperty{
LogGroup: jsii.String("logGroup"),
LogStream: jsii.String("logStream"),
}
type CfnPentest_CustomHeaderProperty ¶
type CfnPentest_CustomHeaderProperty struct {
// Name of the header.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-customheader.html#cfn-securityagent-pentest-customheader-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// Value of the header.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-customheader.html#cfn-securityagent-pentest-customheader-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
A custom header to include in outbound requests.
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"
customHeaderProperty := &CustomHeaderProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnPentest_DocumentInfoProperty ¶
type CfnPentest_DocumentInfoProperty struct {
// Artifact identifier.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-documentinfo.html#cfn-securityagent-pentest-documentinfo-artifactid
//
ArtifactId *string `field:"optional" json:"artifactId" yaml:"artifactId"`
// S3 document location.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-documentinfo.html#cfn-securityagent-pentest-documentinfo-s3location
//
S3Location *string `field:"optional" json:"s3Location" yaml:"s3Location"`
}
A document stored in S3 that provides context for the pentest.
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"
documentInfoProperty := &DocumentInfoProperty{
ArtifactId: jsii.String("artifactId"),
S3Location: jsii.String("s3Location"),
}
type CfnPentest_EndpointProperty ¶
type CfnPentest_EndpointProperty struct {
// URI of the endpoint to test.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-endpoint.html#cfn-securityagent-pentest-endpoint-uri
//
Uri *string `field:"optional" json:"uri" yaml:"uri"`
}
An endpoint to be tested during the pentest.
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"
endpointProperty := &EndpointProperty{
Uri: jsii.String("uri"),
}
type CfnPentest_IntegratedRepositoryProperty ¶
type CfnPentest_IntegratedRepositoryProperty struct {
// Unique identifier of the provider integration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-integratedrepository.html#cfn-securityagent-pentest-integratedrepository-integrationid
//
IntegrationId *string `field:"required" json:"integrationId" yaml:"integrationId"`
// Identifier of the resource within the provider integration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-integratedrepository.html#cfn-securityagent-pentest-integratedrepository-providerresourceid
//
ProviderResourceId *string `field:"required" json:"providerResourceId" yaml:"providerResourceId"`
}
A repository connected via a provider integration.
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"
integratedRepositoryProperty := &IntegratedRepositoryProperty{
IntegrationId: jsii.String("integrationId"),
ProviderResourceId: jsii.String("providerResourceId"),
}
type CfnPentest_NetworkTrafficConfigProperty ¶
type CfnPentest_NetworkTrafficConfigProperty struct {
// Custom headers to include in outbound requests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficconfig.html#cfn-securityagent-pentest-networktrafficconfig-customheaders
//
CustomHeaders interface{} `field:"optional" json:"customHeaders" yaml:"customHeaders"`
// Ordered list of network traffic rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficconfig.html#cfn-securityagent-pentest-networktrafficconfig-rules
//
Rules interface{} `field:"optional" json:"rules" yaml:"rules"`
}
Network traffic configuration for the pentest.
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"
networkTrafficConfigProperty := &NetworkTrafficConfigProperty{
CustomHeaders: []interface{}{
&CustomHeaderProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
Rules: []interface{}{
&NetworkTrafficRuleProperty{
Effect: jsii.String("effect"),
NetworkTrafficRuleType: jsii.String("networkTrafficRuleType"),
Pattern: jsii.String("pattern"),
},
},
}
type CfnPentest_NetworkTrafficRuleProperty ¶
type CfnPentest_NetworkTrafficRuleProperty struct {
// Whether to allow or deny traffic matching this rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-effect
//
Effect *string `field:"optional" json:"effect" yaml:"effect"`
// Type of pattern matching for this rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-networktrafficruletype
//
NetworkTrafficRuleType *string `field:"optional" json:"networkTrafficRuleType" yaml:"networkTrafficRuleType"`
// URL pattern this rule applies to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-pattern
//
Pattern *string `field:"optional" json:"pattern" yaml:"pattern"`
}
Network traffic rule.
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"
networkTrafficRuleProperty := &NetworkTrafficRuleProperty{
Effect: jsii.String("effect"),
NetworkTrafficRuleType: jsii.String("networkTrafficRuleType"),
Pattern: jsii.String("pattern"),
}
type CfnPentest_SourceCodeRepositoryProperty ¶
type CfnPentest_SourceCodeRepositoryProperty struct {
// S3 source code location.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-sourcecoderepository.html#cfn-securityagent-pentest-sourcecoderepository-s3location
//
S3Location *string `field:"optional" json:"s3Location" yaml:"s3Location"`
}
A source code archive stored in S3 for analysis during the pentest.
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"
sourceCodeRepositoryProperty := &SourceCodeRepositoryProperty{
S3Location: jsii.String("s3Location"),
}
type CfnPentest_VpcConfigProperty ¶
type CfnPentest_VpcConfigProperty struct {
// List of security groups in the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html#cfn-securityagent-pentest-vpcconfig-securitygrouparns
//
SecurityGroupArns *[]*string `field:"optional" json:"securityGroupArns" yaml:"securityGroupArns"`
// List of subnets in the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html#cfn-securityagent-pentest-vpcconfig-subnetarns
//
SubnetArns *[]*string `field:"optional" json:"subnetArns" yaml:"subnetArns"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html#cfn-securityagent-pentest-vpcconfig-vpcarn
//
VpcArn *string `field:"optional" json:"vpcArn" yaml:"vpcArn"`
}
VPC configuration that the pentest agent accesses.
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"
vpcConfigProperty := &VpcConfigProperty{
SecurityGroupArns: []*string{
jsii.String("securityGroupArns"),
},
SubnetArns: []*string{
jsii.String("subnetArns"),
},
VpcArn: jsii.String("vpcArn"),
}
type CfnTargetDomain ¶
type CfnTargetDomain interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssecurityagent.ITargetDomainRef
awscdk.ITaggableV2
// Timestamp when the target domain was registered.
AttrCreatedAt() *string
// Unique identifier of the target domain.
AttrTargetDomainId() *string
// Verification details to verify registered target domain.
AttrVerificationDetails() awscdk.IResolvable
// Current verification status of the registered target domain.
AttrVerificationStatus() *string
// Reason for the current target domain verification status.
AttrVerificationStatusReason() *string
// Timestamp when the target domain was last successfully verified.
AttrVerifiedAt() *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{}
CfnPropertyNames() *map[string]*string
// 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
// 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 for the target domain.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Domain name of the target domain.
TargetDomainName() *string
SetTargetDomainName(val *string)
// A reference to a TargetDomain resource.
TargetDomainRef() *interfacesawssecurityagent.TargetDomainReference
// 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{}
// Verification method for the target domain.
VerificationMethod() *string
SetVerificationMethod(val *string)
// 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 cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::SecurityAgent::TargetDomain.
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"
cfnTargetDomain := awscdk.Aws_securityagent.NewCfnTargetDomain(this, jsii.String("MyCfnTargetDomain"), &CfnTargetDomainProps{
TargetDomainName: jsii.String("targetDomainName"),
VerificationMethod: jsii.String("verificationMethod"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTargetDomain ¶
func NewCfnTargetDomain(scope constructs.Construct, id *string, props *CfnTargetDomainProps) CfnTargetDomain
Create a new `AWS::SecurityAgent::TargetDomain`.
type CfnTargetDomainProps ¶
type CfnTargetDomainProps struct {
// Domain name of the target domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-targetdomain.html#cfn-securityagent-targetdomain-targetdomainname
//
TargetDomainName *string `field:"required" json:"targetDomainName" yaml:"targetDomainName"`
// Verification method for the target domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-targetdomain.html#cfn-securityagent-targetdomain-verificationmethod
//
VerificationMethod *string `field:"required" json:"verificationMethod" yaml:"verificationMethod"`
// Tags for the target domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-targetdomain.html#cfn-securityagent-targetdomain-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTargetDomain`.
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"
cfnTargetDomainProps := &CfnTargetDomainProps{
TargetDomainName: jsii.String("targetDomainName"),
VerificationMethod: jsii.String("verificationMethod"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTargetDomain_DnsVerificationProperty ¶
type CfnTargetDomain_DnsVerificationProperty struct {
// Record name to be added in DNS for target domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-dnsverification.html#cfn-securityagent-targetdomain-dnsverification-dnsrecordname
//
DnsRecordName *string `field:"optional" json:"dnsRecordName" yaml:"dnsRecordName"`
// Type of record to be added in DNS for target domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-dnsverification.html#cfn-securityagent-targetdomain-dnsverification-dnsrecordtype
//
DnsRecordType *string `field:"optional" json:"dnsRecordType" yaml:"dnsRecordType"`
// Token used to verify domain ownership.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-dnsverification.html#cfn-securityagent-targetdomain-dnsverification-token
//
Token *string `field:"optional" json:"token" yaml:"token"`
}
Represents DNS TXT verification details.
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"
dnsVerificationProperty := &DnsVerificationProperty{
DnsRecordName: jsii.String("dnsRecordName"),
DnsRecordType: jsii.String("dnsRecordType"),
Token: jsii.String("token"),
}
type CfnTargetDomain_HttpVerificationProperty ¶
type CfnTargetDomain_HttpVerificationProperty struct {
// Route path where verification token should be placed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-httpverification.html#cfn-securityagent-targetdomain-httpverification-routepath
//
RoutePath *string `field:"optional" json:"routePath" yaml:"routePath"`
// Token used to verify domain ownership.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-httpverification.html#cfn-securityagent-targetdomain-httpverification-token
//
Token *string `field:"optional" json:"token" yaml:"token"`
}
Represents HTTP route verification details.
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"
httpVerificationProperty := &HttpVerificationProperty{
RoutePath: jsii.String("routePath"),
Token: jsii.String("token"),
}
type CfnTargetDomain_VerificationDetailsProperty ¶
type CfnTargetDomain_VerificationDetailsProperty struct {
// Represents DNS TXT verification details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-verificationdetails.html#cfn-securityagent-targetdomain-verificationdetails-dnstxt
//
DnsTxt interface{} `field:"optional" json:"dnsTxt" yaml:"dnsTxt"`
// Represents HTTP route verification details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-verificationdetails.html#cfn-securityagent-targetdomain-verificationdetails-httproute
//
HttpRoute interface{} `field:"optional" json:"httpRoute" yaml:"httpRoute"`
// Type of domain ownership verification method.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-targetdomain-verificationdetails.html#cfn-securityagent-targetdomain-verificationdetails-method
//
Method *string `field:"optional" json:"method" yaml:"method"`
}
Verification details to verify registered target domain.
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"
verificationDetailsProperty := &VerificationDetailsProperty{
DnsTxt: &DnsVerificationProperty{
DnsRecordName: jsii.String("dnsRecordName"),
DnsRecordType: jsii.String("dnsRecordType"),
Token: jsii.String("token"),
},
HttpRoute: &HttpVerificationProperty{
RoutePath: jsii.String("routePath"),
Token: jsii.String("token"),
},
Method: jsii.String("method"),
}
Source Files
¶
- CfnAgentSpace.go
- CfnAgentSpaceProps.go
- CfnAgentSpace_AWSResourcesProperty.go
- CfnAgentSpace_CodeReviewSettingsProperty.go
- CfnAgentSpace_IntegratedResourceProperty.go
- CfnAgentSpace_VpcConfigProperty.go
- CfnAgentSpace__checks.go
- CfnApplication.go
- CfnApplicationProps.go
- CfnApplication_IdCConfigurationProperty.go
- CfnApplication__checks.go
- CfnPentest.go
- CfnPentestProps.go
- CfnPentest_ActorProperty.go
- CfnPentest_AssetsProperty.go
- CfnPentest_AuthenticationProperty.go
- CfnPentest_CloudWatchLogProperty.go
- CfnPentest_CustomHeaderProperty.go
- CfnPentest_DocumentInfoProperty.go
- CfnPentest_EndpointProperty.go
- CfnPentest_IntegratedRepositoryProperty.go
- CfnPentest_NetworkTrafficConfigProperty.go
- CfnPentest_NetworkTrafficRuleProperty.go
- CfnPentest_SourceCodeRepositoryProperty.go
- CfnPentest_VpcConfigProperty.go
- CfnPentest__checks.go
- CfnTargetDomain.go
- CfnTargetDomainProps.go
- CfnTargetDomain_DnsVerificationProperty.go
- CfnTargetDomain_HttpVerificationProperty.go
- CfnTargetDomain_VerificationDetailsProperty.go
- CfnTargetDomain__checks.go
- main.go